Export()

Description:

The Export method exports a contact from a contacts database. The information is exported to a vCard file.

This method can be called both synchronously and asynchronously.

Syntax:

For synchronous calls:

Export(parameters:Object):Object

For asynchronous calls:

Export(parameters:Object, callback:Object):Object

Arguments:

  • parameters:

    This is an object that specifies the contact to export and optionally the source database. For more information about the object properties and how to define them, see section Parameters for exporting a contact.

  • callback:

    The callback argument is the name of the method that is executed when an asynchronous Export call has results or status information to return. You must define this method separately. Follow the instructions in section Defining the callback handler for an asynchronous method to define the callback method.

    This argument is used only with an asynchronous Export call.

Return value:

If synchronous, the Export method returns an object that contains an error code and an error message.

If asynchronous, the method returns an object that contains a transaction ID for the callback instance, an error code, and an error message. When the asynchronous call has completed, callback returns an object that contains an error code and an error message (see Table: Callback return value).

Table: Return value properties for Export

Property

Description

Value

TransactionID

This is a number used as an identification to match transactions started with an asynchronous Export call to one or more calls it generates to callback.

This property is only valid for asynchronous calls.

  

ErrorCode

This is a number that specifies a predefined error code.

See Service API error codes.

ErrorMessage

This is a text string that describes the error.

Remarks:

  • The default contacts database is cntdb://c:contacts.cdb.

  • SIM card databases only support name and number keys for vCard.

Example code:

The following sample code illustrates how to export a contact synchronously:

import com.nokia.lib.Service;
var contact = new Service("Service.Contact", "IDataSource");
var inputData = {DestinationFile:"c:\\contact.vcf", id:contactId};//valid contactId which is a String
var inParams = {Type:"Contact", Data:inputData};
var outParams = contact.Export(inParams);
var errorId = outParams.ErrorCode;

The following sample code illustrates how to export a contact asynchronously:

import com.nokia.lib.Service;
var contact = new Service("Service.Contact", "IDataSource");
var inputData = {DestinationFile:"c:\\contact.vcf", id:contactId};//valid contactId which is a String
var inParams = {Type:"Contact", Data:inputData};
contact.Export(inParams,onExport);
function onExport (transactionID:Number, eventID:String, outParam:Object) {
var errorId = outParam.ErrorCode;
}
© Nokia 2009.