ACCESS Developer Network | Exchange Verbs | Data, Rarr, ^top^, String, Operation

The following sections list all available exchange handlers in the platform, by the component or application that handles the exchange, along with the description of supported verb/mime-type (or data-type) associations, expected parameters, and a description of the provided services.

Audio Application ^TOP^

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Play an audio file.

Data Types

"audio/mpeg"
"audio/x-ms-wma"
"audio/x-mpegurl"
"audio/x-wav"
"audio/x-amr"
"audio/mid"
"audio/mobile-xmf"
"audio/melody"

Parameters

→ ALP_EXGMGR_FILENAME_PARAM: (string) Path to the audio file to be played. The path string cannot exceed 256 characters, including the terminating NULL.

ALP_EXGMGR_DISPLAY_DRM1_0_VERB ^TOP^

Purpose

Play an audio file.

Data Types

"audio/mpeg"
"audio/x-ms-wma"
"audio/x-mpegurl"
"audio/x-wav"
"audio/x-amr"
"audio/mid"
"audio/mobile-xmf"
"audio/melody"

Parameters

→ ALP_EXGMGR_FILENAME_PARAM: (string) Path to the audio file to be played. The path string cannot exceed 256 characters, including the terminating NULL.

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Accept an audio file received from a remote device.

Data Types

"audio/mp3"

Parameters

→ ALP_EXGMGR_OBEX_OBJECT_FILE_BASE: (string) String containing the name of the file to be stored. The path string cannot exceed 256 characters, including the terminating NULL.

Calendar Application ^TOP^

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Stores one or more calendar entries received from a legacy device into the calendar database.

Data Types

"text/x-vcalendar"
".vcs"
".ics"

Parameters

→ <fd data>: (file descriptor, optional) The vCal data to be stored.
→ <object>: (string, optional) Filename of a file containing vCal data to be stored.

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Create a new entry in the calendar database containing the supplied data. Unless an empty calendar record is being created, the user is asked to confirm the new calendar entry (or To Do item) and optionally specify a category for it before it is stored in the database.

Data Types

ALP_EXGMGR_CALENDAR_GENERIC_EMPTY_MIME_TYPE: This data type creates an empty calendar database entry.
ALP_EXGMGR_CALENDAR_MIME_TYPE
"text/x-vcalendar"

Parameters

→ <data objects>: (optional) The data object containing the vCal data to be stored. This parameter is required unless the request is creating an empty record.

ALP_EXGMGR_GET_VERB ^TOP^

Purpose

Display the Calendar and return the event selected by the user.

Data Types

ALP_EXGMGR_CALENDAR_MIME_TYPE
"text/x-vcalendar"

Parameters

← ALP_EXGMGR_IDENTIFIER_PARAM: (string) Locally unique ID of the selected calendar event, as a string.
← ALP_EXGMGR_FILENAME_PARAM: (string) Filename of the event being returned.
← <fd data>: (file descriptor) The event.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The Exchange verb is not recognized.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a calendar entry.
other error values: There was a problem completing the operation.

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Display a calendar event.

Data Types

ALP_EXGMGR_CALENDAR_MIME_TYPE
"text/x-vcalendar"

Parameters

→ ALP_EXGMGR_IDENTIFIER_PARAM: (string, optional) Locally unique ID (luid) of the event to be displayed.
→ <data objects>: (optional) The data objects containing the data to be displayed.
→ ALP_EXGMGR_EDITABLE_PARAM: (int, optional) Specifies whether the displayed data item should be editable. The parameter should be an integer, zero (not editable) or nonzero (editable). If not supplied, "editable" is assumed by default.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The Exchange verb is not recognized.
other error values: There was a problem completing the operation.

Comments

If neither a luid nor a file descriptor is supplied, the user will be allowed to select an event for display.

Camera Application ^TOP^

ALP_CAM_RECORD ^TOP^

Purpose

Capture a picture.

Data Types

"image/jpg"
"video/ogg"

Parameters

→ "path": (string) Path to file into which the captured image should be written.
→ "size": (int, optional) The maximum desired size of the image, in bytes.
← "file": (string) The name of the file containing the captured image.
← "result": (int) 0 if the image was captured successfully, 1 otherwise.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_CAM_ARG_PARSE_ERR: The Exchange verb or MIME type were not recognized.
other error values: There was a problem completing the operation.

CAT Browser ^TOP^

"Execute" ^TOP^

Purpose

Starts the CAT Browser application when it is not already launched, upon request by a USAT application.

Data Types

"Proactive"

Parameters

→ "CmdId": (int) USAT proactive command identifier

Returns

ALP_EXG_MGR_ERR_HANDLER_DID_NOT_CONSUME_ERROR: The registered handler did not consume the request.
other error values: There was a problem completing the operation.

Comments

A USAT application can be started at Phone Network initiative. The parameter sent with the Exchange verb is the first proactive command ID issued by this USAT session.

Contacts Application ^TOP^

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Create a new entry in the contacts database containing the supplied data. Unless an empty contacts record is being created, the user is asked to confirm the new contact and optionally specify a category for the contact before it is stored in the database. Optionally allow the user to edit the contact record(s) after they are created.

Contacts can be created either by specifying vCard data, or by specifying "generic" data (a phone number, an email address, or a URL), or by specifying nothing, which creates an empty record for the user to fill in.

Data Types

"application/vcf"
"text/x-vcard"
"text/directory"
"alp_exg_generic_phone_string"
"alp_exg_generic_email_string"
"alp_exg_generic_url_string"
ALP_EXGMGR_CONTACTS_GENERIC_EMPTY_MIME_TYPE: This data type creates an empty contacts database entry.

Parameters

→ ALP_EXGMGR_CONTACTS_SHOW_UI_PARAM: (int, optional) Indicates whether or not the user should be given a chance to edit the contact. Set this parameter to zero to prevent the UI from being shown. If this parameter is not set, or is set to a nonzero value, the UI will be shown.
→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string, optional, 256 characters maximum) Data to be stored when the request is made in generic mode. If the request is not a generic one, this parameter is ignored. This string should either contain a phone number, an email address, a URL, or an empty string; the corresponding MIME type should be "alp_exg_generic_phone_string", "alp_exg_generic_email_string", "alp_exg_generic_url_string", or ALP_EXGMGR_CONTACTS_GENERIC_EMPTY_MIME_TYPE, respectively. Note that this parameter must be present (although its value is ignored) for an "empty_contact".
→ <data objects>: (optional) The data objects containing the vCard data to be stored. This parameter is required if the request is not in generic mode.
← ALP_EXGMGR_IDENTIFIER_PARAM: (string) Upon return, this is set to the locally unique ID of the first (usually, the only) newly-created contacts database record.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The Exchange verb is not recognized.
ALP_EXGMGR_ERR_OUT_OF_MEMORY_ERROR: There was insufficient memory to complete the operation.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not accept the new contacts entry.
other error values: There was a problem completing the operation.

Comments

Use the generic types ("alp_exg_generic_phone_string", "alp_exg_generic_email_string", "alp_exg_generic_url_string", and ALP_EXGMGR_CONTACTS_GENERIC_EMPTY_MIME_TYPE, ) to store generic data (such as a phone number). When any of these MIME types are specified, the Contacts application creates a vCard and presents the Contact Edit View. ALP_EXGMGR_CONTACTS_GENERIC_EMPTY_MIME_TYPE ("empty_contact") lets you present an empty contact for editing.

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Stores one or more contacts received from a legacy device into the contacts database.

Data Types

"text/x-vcard"
"text/directory"
".vcf"

Parameters

→ <data objects>: The data objects containing vCard data to be stored.

ALP_EXGMGR_GET_VERB ^TOP^

Purpose

Get data about a contact. The user is allowed to select the contact. What is returned depends upon parameters passed.

Data Types

ALP_EXGMGR_CONTACTS_MIME_TYPE ("application/vcf"),
"text/x-vcard",
"text/directory"

Parameters

↔ ALP_EXGMGR_CONTACTS_CONTACT_TYPE_PARAM: (string, optional input) If present, used to limit the info returned to the desired contact type value and friendly name (returned in ALP_EXGMGR_FILENAME_PARAM). Also restricts the picker to show only contacts that have data of this type. On output it will contain the value. Note where multiple values are present, only the first one will be returned. You can use the ALP_EXG2_PHONESTRING_SUBJECT if you want to get any phone number. Use kDistributionContactTypeMessaging (declared in contacts_dml.h) if you want any phone number and/or email.
← ALP_EXGMGR_CONTACTS_CONTACT_LUID_PARAM: (int) The local user ID of the selected contact.
← ALP_EXGMGR_IDENTIFIER_PARAM: (string) A string representation of the local user ID of the selected contact. Not present on errors or if user cancels selection.
← ALP_EXGMGR_FILENAME_PARAM: (string) If ALP_EXGMGR_CONTACTS_CONTACT_TYPE_PARAM is specified, this is the friendly name of the selected contact. If a file is returned then this is the name of the file (the file is located in /tmp).
← <fd data>: (file descriptor) The vCard data. Not present if ALP_EXGMGR_CONTACTS_CONTACT_TYPE_PARAM is specified.
→ ALP_EXGMGR_CONTACTS_CATEGORY_OK_PARAM: (int, optional) If present, and non-zero, the user will be allowed to select an entire category. Defaults to 0.
→ ALP_EXGMGR_CONTACTS_DISTRIBUTION_OK_PARAM: (int, optional) Indicates whether or not the user can select a distribution group. This parameter, if supplied, should have one of the following values:
→ ALP_EXGMGR_CONTACTS_DISTRIBUTION_CONTACT_TYPE_PARAM: (string, optional) If present, this is used to limit the info returned to the specified distribution type. See contacts_dml.h for valid values. By default no limit is imposed.
← ALP_EXGMGR_CONTACTS_CATEGORY_WAS_SELECTED_PARAM: (int) If the user was allowed to select a category, this value is set upon return. Zero indicates that no category was selected, while a nonzero value indicates that one was selected. See ALP_EXGMGR_CONTACTS_CATEGORY_SELECTED_PARAM for the selected category.
← ALP_EXGMGR_CONTACTS_CATEGORY_SELECTED_PARAM: (int) If the user was allowed to select a category and the user did indeed select one, this parameter is set to the selected category.
← ALP_EXGMGR_CONTACTS_DISTRIBUTION_WAS_SELECTED_PARAM: (int) If the user was allowed to select a distribution group, this value is set upon return. Zero indicates that the user did not select a distribution group, while a nonzero value indicates that one was selected. See ALP_EXGMGR_CONTACTS_DISTRIBUTION_SELECTED_PARAM for the selected distribution group.
← ALP_EXGMGR_CONTACTS_DISTRIBUTION_SELECTED_PARAM: (int) If the user was allowed to select a distribution group and the user did indeed select one, this parameter is set to the selected distribution group.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The Exchange verb is not recognized.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a contact.
other error values: There was a problem completing the operation.

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Display a contact, either one in the contacts database identified by a locally unique ID, or one encapsulated in a vCard, or one chosen by the user.

Data Types

ALP_EXGMGR_CONTACTS_MIME_TYPE ("application/vcf"),
"text/x-vcard",
"text/directory"

Parameters

→ ALP_EXGMGR_IDENTIFIER_PARAM: (string, optional) Locally unique ID of the item to be displayed, as a string.
→ <fd data>: (file descriptor, optional) The vCard data. Do not supply a value for ALP_EXGMGR_IDENTIFIER_PARAM if you are displaying the contents of a vCard specified through a file descriptor parameter.
→ ALP_EXGMGR_EDITABLE_PARAM: (int, optional) Specifies whether the displayed data item should be editable. The parameter should be an integer, zero (not editable) or nonzero (editable). If not supplied, "editable" is assumed by default.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The Exchange verb is not recognized.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a contact.
other error values: There was a problem completing the operation.

Comments

If a file is not supplied and the locally unique ID is either not supplied or is zero, the user gets to choose a contact to be displayed.

Document Viewer ^TOP^

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Display the contents of a document.

Data Types

"application/msword"
"application/vnd.ms-excel"
"application/vnd.ms-powerpoint"
"application/pdf"
"text/plain"

Parameters

→ ALP_EXGMGR_FILENAME_PARAM: (string) Path to the file to be displayed.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

Download Manager ^TOP^

"alp_download" ^TOP^

Purpose

Basic HTTP download.

Data Types

ALP_EXG2_URLSTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string) URL.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

"alp_oma_download" ^TOP^

Purpose

OMA download with a download descriptor in a buffer.

Data Types

ALP_EXG2_URLSTRING_SUBJECT

Parameters

→ "base_url": (string) The URL to get download descriptor content.
→ "content_length": (int) Length of download descriptor, in bytes.
→ "content_str": (string) Download descriptor.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

OMA download when download descriptor already saved as a file.

Data Types

ALP_EXG2_URLSTRING_SUBJECT

Parameters

→ <object fd, or object>: (object_fd, or object) Either a file descriptor or path to the file that contains the download descriptor. The Download Manager uses alp_exg_utils_store_request_get_object_fd() to obtain the object's file descriptor; if this call fails, it then tries alp_exg_utils_store_request_get_object() to get the filename.

Email Application ^TOP^

"sendemail" (with mailto:) ^TOP^

Purpose

Open a new compose window, with the "to" address filled in as specified.

Data Types

"text/RFC2368"

Parameters

→ "mailto_url": (string) "Mailto" string. For example, "mailto: This e-mail address is being protected from spam bots, you need JavaScript enabled to view it ".

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

"sendemail" (with email address) ^TOP^

Purpose

Open a new compose window, with the "to" address filled in as specified.

Data Types

ALP_EXG2_EMAILSTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string, optional) A single email address that should go in the TO field.
→ <data objects>: (optional) A data object containing the address to which the email should be sent.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

"sendemail" (with attachments) ^TOP^

Purpose

Open a new compose window, with one or more files attached to the new email message.

Data Types

"*" (all data types)

Parameters

→ <one or more objects>: (objects) Use alp_exg_utils_store_request_add_object() to specify the files to be attached to the email message.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

ALP_POSTAL_EMAIL_ATTENTION_EXCHANGE_VERB_DISPLAY ^TOP^

Purpose

POP and IMAP email plugins use this verb when they post a new Attention Manager item. When a user clicks on an email alert in the Attention Manager, the Exchange Manager is invoked with this verb. The Email application is then invoked to display the email to the user.

Data Types

ALP_POSTAL_EMAIL_ATTENTION_EXCHANGE_MIME_TYPE

Parameters

→ "serviceId": (int) Service ID, such as ALP_POSTAL_SERVICE_ID_POP or ALP_POSTAL_SERVICE_ID_IMAP.
→ "accountId": (int) ID of a valid email account.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

File Manager ^TOP^

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Stores a file and registers it with the Media Cataloger.

Data Types

"*"

Parameters

→ <fd data>: (file descriptor) The file to be stored.
→ ALP_EXGMGR_FILENAME_PARAM: (string, optional) The base filename to be used when storing the file. If not supplied, a default filename will be used. If a full path is supplied, the path will be ignored, and only the base filename will be used. The path to the directory in which the file is stored is determined by the Media Framework based upon the filetype.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

ALP_EXGMGR_GET_VERB ^TOP^

Purpose

Allow the user to select a file (limiting the files from which they can select to those that match the specified data type). The selected file is sent back as an OBEX object. If the user selects multiple files, only the first one is sent back.

Data Types

"*"
"audio/*"
"video/*"
"image/*"
"ringtone/*"
"application/*"
"other/*"

Parameters

← ALP_EXGMGR_FILENAME_PARAM: (string) The full path to the selected file.

Comments

If the user selects a file, the File Manager creates a new request and sends the file back as an OBEX object. Along with the file it includes the path to the file (including the filename) as the value of the ALP_EXGMGR_FILENAME_PARAM parameter.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The Exchange verb could not be handled.
other error values: There was a problem completing the operation.

Instant Messaging Application ^TOP^

"Chat" ^TOP^

Purpose

Launch a chat session given an email address.

Data Types

ALP_EXG2_EMAILSTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string) The email address that is to be used to launch the chat session.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: Unknown exchange verb or invalid MIME type.
other error values: There was a problem completing the operation.

Web Browser ^TOP^

"Open" ^TOP^

Purpose

Open a URL in the browser.

Data Types

ALP_EXG2_URLSTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string) The URL to be opened.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

"SAVE" ^TOP^

Purpose

None: currently, the browser registers for this verb/MIME type combination, but does nothing with it.

Data Types

"text/html"

Parameters

none

"PLAY" ^TOP^

Purpose

None: currently, the browser registers for this verb/MIME type combination, but does nothing with it.

Data Types

"text/html"

Parameters

none

Memo Application ^TOP^

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Display a memo to the user or allow the user to select a memo for display. The memo can be presented either for display or for editing.

Data Types

"application/vnt"
"text/x-vnote"
"text/plain"
".txt"
".vnt"

Parameters

→ ALP_EXGMGR_IDENTIFIER_PARAM: (string, optional) Locally unique ID of the memo to be displayed, as a string.
→ ALP_EXGMGR_EDITABLE_PARAM: (int, optional) Indicates whether or not the memo should be editable. Zero indicates read-only. If this parameter is not set the memo will be editable.
→ <fd data>: (file descriptor, optional) The memo (vNote) to be displayed. If the ALP_EXGMGR_IDENTIFIER_PARAM parameter is set, the file descriptor is ignored.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_READ_ERROR: The application cannot read from the supplied file descriptor.
ALP_EXGMGR_ERR_BUF_TOO_SMALL_ERROR: The file contains a memo that is too large to be displayed.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a memo to be displayed.
other error values: There was a problem completing the operation.

Comments

If neither a locally unique ID nor a file descriptor are provided, the user is allowed to select an existing memo to be displayed.

ALP_EXGMGR_GET_VERB ^TOP^

Purpose

Return a memo selected by the user.

Data Types

"application/vnt"
"text/x-vnote"

Parameters

← ALP_EXGMGR_IDENTIFIER_PARAM: (string) The locally unique identifier of the user-selected memo, as a string.
← ALP_EXGMGR_FILENAME_PARAM: (string) The vNote filename.
← <fd data>: (file descriptor) The chosen memo.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a memo.
other error values: There was a problem completing the operation.

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Store one or more memos in the memo database. If the Exchange request is generic (the MIME type for such as request must be "empty_memo"), a new, empty memo is created and presented to the user for editing.

The user is given an opportunity to confirm the storage of the memos and select a category for them.

Data Types

"empty_memo"
"application/vnt"
"text/x-vnote"

Parameters

→ <fd data>: (file descriptor, optional) The memo (or memos) to be stored. If the request is not generic, this parameter must be supplied.
← ALP_EXGMGR_IDENTIFIER_PARAM: (string) Locally unique ID of the newly-added memo, as a string.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: When prompted whether or not the memo should be added to the database, the user chose not to have it added.
other error values: There was a problem completing the operation.

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Stores one or more memos received from a legacy device into the memo database.

The user is given an opportunity to confirm the storage of the memos and select a category for them.

Data Types

"application/vnt"
"text/x-vnote"
"text/plain"
".vnt"
".txt"

Parameters

→ <data objects>: The data objects containing vNote data to be stored.

Messaging Application ^TOP^

"send" ^TOP^

Purpose

Send an SMS message.

Data Types

"application/x-messaging"

Parameters

prv_msg_exg_verb_transient_send(), prv_msg_exg_verb_send()
→ "Type": (string) The MIME type of the content parameter.
→ "PhoneNum": (string, optional) The phone number to which the message should be sent, as a string.
→ "Content": (string, optional) The content to be sent, as plain text.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

Comments

If both a phone number and a content string are supplied, the message is sent as an SMS without user intervention. If only one is supplied, or neither are supplied, the messaging application's "Compose" form is opened with either the "To" field, or the text field, or neither, filled in as appropriate.

"send" ^TOP^

Purpose

Open the messaging application's "Compose" form with the "To" field set to the specified phone number.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string) The phone number, as a string. Up to 64 digits.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_OBEX_PARAM_NOT_ALLOWED_ERROR: The supplied phone number exceeds 64 digits.
other error values: There was a problem completing the operation.

"send" ^TOP^

Purpose

Open the messaging application's "Compose" form, with the specified objects set as attachments.

Data Types

"*" (all data types)

Parameters

→ <one or more objects>: (objects) Use alp_exg_utils_store_request_add_object() to specify the files to be attached to the email message.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

"view" ^TOP^

Purpose

Open the Messaging application's "View" form and view or play the specified SMS or MMS message.

Data Types

"application/x-messaging"

Parameters

→ "EnvelopeId": (int) The envelope ID of the SMS or MMS message to be displayed.

Returns

ALP_STATUS_OK

"reply" ^TOP^

Purpose

Open the Messaging application's "Compose" form and allow the user to reply to the specified SMS or MMS message.

Data Types

"application/x-messaging"

Parameters

→ "EnvelopeId": (int) The envelope ID of the SMS or MMS message to be replied to.

Returns

ALP_STATUS_OK

"forward" ^TOP^

Purpose

Open the Messaging application's "Compose" form and allow the user to forward the specified SMS or MMS message.

Data Types

"application/x-messaging"

Parameters

→ "EnvelopeId": (int) The envelope ID of the SMS or MMS message to be forwarded.

Returns

ALP_STATUS_OK

"download" ^TOP^

Purpose

Retrieve the specified MMS message's content.

Data Types

"application/x-messaging"

Parameters

→ "EnvelopeId": (int) The envelope ID of the SMS or MMS message to be downloaded.

Returns

ALP_STATUS_OK

"retrieve" ^TOP^

Purpose

Data Types

"application/x-messaging"

Parameters

→ "href": (string)
→ "action": (int, optional) One of the following:

Returns

ALP_STATUS_OK

"delete" ^TOP^

Purpose

Delete a specified SMS or MMS message.

Data Types

"application/x-messaging"

Parameters

→ "EnvelopeId": (int) The envelope ID of the SMS or MMS message to be deleted.

Returns

ALP_STATUS_OK

Mobile Telephony Server ^TOP^

"compute" ^TOP^

Purpose

Dial a phone number and optionally send a string of DTMF characters.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

→ "type": (string) One of the following values:
→ "number": (string) The number to be dialed. This parameter is ignored if the "type" parameter is "emergency" or "voicemail".
→ "dtmf": (string) DTMF characters to be sent once the call has been established. This parameter is ignored unless the "type" parameter is "dtmf".

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_OBEX_PARAM_NOT_ALLOWED_ERROR: The "type" parameter is "normal" or "dtmf" but a value for the "number" parameter was not supplied, or the "type" parameter is "dtmf" but a value for the "dtmf" parameter was not supplied.
other error values: There was a problem completing the operation.

"released" ^TOP^

Purpose

Create and show the "call ended" dialog based upon the supplied parameters.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

→ "db_name": (string, optional) The caller ID name to be displayed in the dialog. If this value is not supplied, the value of the "number" parameter is used when constructing the string displayed in the dialog.
→ "number": (string, optional) The number that was called. This parameter is ignored unless the "db_name" parameter is not supplied or it is supplied but has zero length. Otherwise, it is used when constructing the string displayed in the dialog.
→ "released_by_me": (int, optional) 1 if the call was released locally, or 0 if it was released by the other party. If this parameter is omitted, its value is assumed to be 0.
→ "hold": (int, optional) 1 if the call is being released from hold. If this parameter is omitted, its value is assumed to be 0.
→ "multiparty": (int, optional) 1 if this was a multiparty call. If this parameter is omitted, its value is assumed to be 0.
→ "duration": (int, optional) The length of the call, in seconds. If this parameter is omitted, its value is assumed to be zero.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

"display" ^TOP^

Purpose

Create and show SIM status information.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

→ "informationType": (int) The type of information to be displayed. One of the following values:

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

Telephone Dialer ^TOP^

"Dial" ^TOP^

Purpose

Dial a supplied phone number.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT
ALP_EXG2_EXTENDEDPHONESTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string) The phone number to be dialed.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_OBEX_PARAM_NOT_ALLOWED_ERROR: The supplied phone number exceeds 64 digits.
ALP_EXG_MGR_ERR_TRANSPORT_BUSY_ERROR: The phone circuitry is in use.
other error values: There was a problem completing the operation.

"Dial" ^TOP^

Purpose

Dial a pre-set number.

Data Types

"Voice": Dial the user's voicemail.
"Emergency": Dial the emergency number.

Parameters

none

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXG_MGR_ERR_TRANSPORT_BUSY_ERROR: The phone circuitry is in use.
other error values: There was a problem completing the operation.

"Dial" ^TOP^

Purpose

Enter a number into the phone dialer and optionally dial it, or simply display the phone dialer.

Data Types

"Phone": Dial the number specified by the "data" parameter.

Parameters

→ "data": (string, optional) The phone number to be dialed, as a string. If no value is supplied for this parameter, the phone dialer is simply displayed to the user without a value already filled in.
→ "dtmf": (string, optional) DTMF characters to be sent once the call has been established.
→ "call": (int, optional) Indicates whether or not the number should be dialed. If this parameter is supplied (with any value at all, or even no value), the specified phone number is dialed. If this parameter is omitted, the dialer is presented to the user (if a value for the "data" parameter has been supplied, with that value filled in).

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_OBEX_PARAM_NOT_ALLOWED_ERROR: The supplied phone number exceeds 64 digits.
ALP_EXG_MGR_ERR_TRANSPORT_BUSY_ERROR: The phone circuitry is in use.
other error values: There was a problem completing the operation.

"accepted" ^TOP^

Purpose

Launch the phone application to display the incoming call

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

none

Returns

ALP_STATUS_OK: The operation completed successfully.

"Quick Text" ^TOP^

Purpose

Launch the phone application when the user rejects a call, to send back an SMS message.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

→ "number": (string) The number to which the user's chosen quick text SMS message is to be sent.

Returns

ALP_STATUS_OK: The operation completed successfully.

Picture Editor ^TOP^

"--alp-picture-edit" ^TOP^

Purpose

Start a picture edit session.

Data Types

"picture"

Parameters

↔ "file-path": (string) Path to the file to be edited.
↔ "collection-name": (string, optional) Name of the collection to which the picture belongs, if any.

Returns

ALP_EXGMGR_ERR_NO_ERROR

Picture Manager ^TOP^

"display" ^TOP^

Purpose

Display a specified image.

Data Types

"picture/display"
"collection/x-ply"
"image/x-ms-bmp"
"image/x-png"
"image/jpeg"
"image/gif"

Parameters

→ ALP_EXGMGR_FILENAME_PARAM: (string) Path to the image to be displayed.

Returns

ALP_STATUS_OK

"display_drm1.0" ^TOP^

Purpose

Display a specified image.

Data Types

"image/x-ms-bmp"
"image/x-png"
"image/jpeg"
"image/gif"

Parameters

→ ALP_EXGMGR_FILENAME_PARAM: (string) Path to the image to be displayed.

Returns

ALP_STATUS_OK

"store" ^TOP^

Purpose

Copy a specified image file to the standard directory designated for images. The Picture Manager determines the standard directory by calling alp_mf_get_media_path().

Data Types

"image/x-ms-bmp"
"image/x-png"
"image/jpeg"
"image/gif"

Parameters

→ ALP_EXGMGR_FILENAME_PARAM: (string) Path to the image file to be copied.

Returns

ALP_STATUS_OK

Garnet VM Preferences Panel ^TOP^

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Data Types

"application/vnd.access-gas"
".gas"

Parameters

none

Security Preferences Panel ^TOP^

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Install a certificate.

Data Types

"application/x-x509-ca-cert",
"application/x-x509-user-cert"
"application/pkcs12"
"application/x-pkcs12"
"application/x-x509-email-cert"

Parameters

→ "appname": (string) The name of the application that is trying to install the certificate.
→ "data": (blob) The certificate.
→ "mode": (int) Pass a value of 0 if the operation should block, or 1 if it should not.
← "result": (int) For blocking operations, this is set to 1 if the certificate was successfully installed, 0 if there was a problem. For non-blocking operations, if one of the supplied parameters was in error, this is set to 0 and the failure code is returned from the exchange request (see "Returns", below).

Returns

ALP_STATUS_OK: The operation completed successfully. If the PRV_SECU_CERTIFICATE_PARAM_MODE parameter is set to non-blocking, ALP_STATUS_OK is returned to indicate that the parameters are correctly supplied (but before the certificate is installed).
1: The exchange verb was not recognized.
other error values: There was a problem completing the operation.

"verify" ^TOP^

Purpose

Display the password dialog and verify that the user entered the correct password.

Data Types

"application/x-text"

Parameters

← "result": (int) This is set to 0 if the user entered the correct password, or 1 if either the user canceled the operation or the operation was interrupted due to an emergency telephone call.

Returns

ALP_STATUS_OK

Tasks Application ^TOP^

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Stores one or more tasks entries received from a legacy device into the tasks database. The user is prompted before the data is stored.

Data Types

ALP_EXGMGR_TASK_MIME_TYPE
"text/x-vtodo"
".vcs"

Parameters

→ <fd data>: (file descriptor, optional) The vTodo data to be stored.

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Creates one or more new task entries based upon the data supplied. If the data type is ALP_EXGMGR_TASK_GENERIC_EMPTY_MIME_TYPE, a new empty task is created. Unless the task is a new empty one, the user is asked to confirm the new task(s) before they are stored in the tasks database.

Data Types

ALP_EXGMGR_TASK_GENERIC_EMPTY_MIME_TYPE
ALP_EXGMGR_TASK_MIME_TYPE
"text/x-vtodo"

Parameters

→ <fd data>: (file descriptor, optional) The vTodo data to be stored. This parameter need not be supplied if the data type is ALP_EXGMGR_TASK_GENERIC_EMPTY_MIME_TYPE.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not accept the new tasks.
other error values: There was a problem completing the operation.

ALP_EXGMGR_GET_VERB ^TOP^

Purpose

Return a task selected by the user.

Data Types

ALP_EXGMGR_TASK_MIME_TYPE
"text/x-vtodo"

Parameters

← ALP_EXGMGR_IDENTIFIER_PARAM: (string) Locally unique ID of the selected task, as a string.
← ALP_EXGMGR_FILENAME_PARAM: (string) Filename of the task being returned.
← <fd data>: (file descriptor) The task.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a task.
other error values: There was a problem completing the operation.

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Display a task.

Data Types

ALP_EXGMGR_TASK_MIME_TYPE
"text/x-vtodo"

Parameters

→ ALP_EXGMGR_IDENTIFIER_PARAM: (string, optional) Locally unique ID (luid) of the task to be displayed.
→ ALP_EXGMGR_EDITABLE_PARAM: (int, optional) Specifies whether the displayed data item should be editable. The parameter should be an integer, zero (not editable) or nonzero (editable). If not supplied, "editable" is assumed by default.
→ <data objects>: The data objects containing the data to be displayed.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_EXGMGR_ERR_USER_CANCEL_ERROR: The user did not select a task.
other error values: There was a problem completing the operation.

Comments

If neither a luid nor a file descriptor is supplied, the user will be allowed to select a task for display.

Video Telephony Application ^TOP^

"VideoCall" ^TOP^

Purpose

Dial a supplied phone number and initiate a video call.

Data Types

ALP_EXG2_PHONESTRING_SUBJECT

Parameters

→ ALP_EXGMGR_GENERIC_DATA_PARAMETER_NAME: (string) The phone number to be dialed.

Returns

ALP_STATUS_OK: The operation completed successfully.
other error values: There was a problem completing the operation.

Video Player ^TOP^

ALP_EXGMGR_DISPLAY_VERB ^TOP^

Purpose

Play a video file.

Data Types

"video/mp4"
"video/x-3gp"
"video/mpeg"

Parameters

→ "filename": (string) Path to the video file to be played. The path string cannot exceed 128 characters, including the terminating NULL.

Returns

ALP_EXGMGR_ERR_NO_ERROR

ALP_EXGMGR_DISPLAY_DRM1_0_VERB ^TOP^

Purpose

Play a video file.

Data Types

"video/x-3gp"
"video/mpeg"

Parameters

→ "filename": (string) Path to the video file to be played. The path string cannot exceed 128 characters, including the terminating NULL.

Returns

ALP_EXGMGR_ERR_NO_ERROR

ALP_EXGMGR_STORE_VERB ^TOP^

Purpose

Copy a video file to "/var/home/public/video".

Data Types

"video/mp4"
"video/3gpp"
"video/mpeg"

Parameters

→ "filename": (string) Path to the video file to be copied. The path string cannot exceed 128 characters, including the terminating NULL.

Returns

ALP_EXGMGR_ERR_NO_ERROR

Voice Recorder ^TOP^

"recordsound" ^TOP^

Purpose

Begin a recording session.

Data Types

"audio/x-wav"
"audio/x-amr"

Parameters

→ "path": (string, optional) Path indicating where the recording should be stored. If a path is not supplied, a unique filename is generated and the file is stored in the /home/RecordedSound/SubRecorded/directory. The complete path to the file containing the recording is returned in the "file" parameter.
→ "rate": (int, optional) The sample rate. Valid rates are: 8000, 11025, 22050, and 44100; if an invalid rate is supplied, or no rate is supplied, 22050 is used.
→ "style": (string, optional) One of the following:; If the "style" parameter is not set to one of the above listed values, or is not supplied, "Control" is used.
← "file": (string) The path to the file containing the recording.
← "result": (int) This parameter is set to zero if the recording was made successfully, or 1 if there was an error.

Returns

ALP_STATUS_OK

"stoprecordsound" ^TOP^

Purpose

Stop a "Float"-style recording made by issuing a "recordsound" exchange request.

Data Types

"audio/x-wav"
"audio/x-amr"

Parameters

← "result": (int) This parameter is set to zero.

Returns

ALP_STATUS_OK

Garnet VM Application Launcher ^TOP^

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Receive and install incoming PRCs or PDBs sent through OBEX from ALP and non-ALP devices (Garnet, PalmOS, or other).

"application/vnd.palm"
".prc"

Parameters

→ <object>: (string, optional) Filename of a file containing the PRC or PDB data to be stored.

Comments

Objects are specified using alp_exg_utils_store_request_add_object APIs. The request should be created using alp_exg_store_request_create() which automatically sets the verb.

Mobile Server ^TOP^

"PhoneKeyReleased" ^TOP^

Purpose

On hook/off hook key handler.

Data Types

"PhoneKey"

Parameters

→ "PhoneKey": (int) The key that was released. This should either be ALP_KEY_ON_HOOK or ALP_KEY_OFF_HOOK.
→ "LongPress": (int) Whether or not the specified key had been pressed for a short time or a long time. A value of zero indicates a short key press, while a nonzero value indicates that the key was given a long press.

Returns

ALP_STATUS_OK: The exchange request was properly formed.
other error values: There was a problem retrieving values associated with the exchange request.

"store" ^TOP^

Purpose

Voicemail waiting indication handler.

Data Types

"sms/vmi"

Parameters

→ "struct_url": (string) The URL for the file that stores the voicemail waiting indication SMS.
→ "struct_url_len": (int) The length of the URL.

Comments

The Mobile Server listens for such exchange requests (generated by the SMS plugin) in order to update the voicemail indicator(s).

Returns

ALP_STATUS_OK: The exchange request was properly formed.
other error values: There was a problem retrieving values associated with the exchange request.

Java Exchange Server ^TOP^

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Install a Java application.

Data Types

"application/java-archive"
"text/vnd.sun.j2me.app-descriptor"
".jar"
".jad"

Parameters

→ ALP_EXGMGR_OBEX_OBJECT_FILE_BASE
→ <object>: (object) Complete pathname for the Java file to be installed.
→ "request-url": (string, optional)

Java Application Launcher ^TOP^

"store" ^TOP^

Purpose

Store a file.

Data Types

"alp_exg_java_file_name_string"

Parameters

→ "filename": Path to the file to be stored.

Returns

ALP_EXGMGR_ERR_NO_ERROR: The request parameters were correct.
ALP_EXG_MGR_ERR_NO_SUCH_REQUEST_ERROR: The exchange verb was not recognized.
other error values: There was a problem completing the operation.

OMA DM Server ^TOP^

WAPPUSH_EXGMRG_VERB ^TOP^

Purpose

Data Types

"application/vnd.wap.connectivity-wbxml"
"application/vnd.syncml.notification"
"application/vnd.syncml.dm+wbxml"

Parameters

→ <fd data>: (file descriptor) .

Comments

Documents of type "application/vnd.wap.connectivity-wbxml" are WAP push messages that contain WBXML encoded OMA Client Provisioning Documents. Exchange Manager requests of verb "get" are generated by the WAP Push module.

WAP Push Library ^TOP^

"store" ^TOP^

Purpose

The WAP Push module listens for "store" exchange requests. These requests are generated by the SMS plugin when it has assembled all the separate WAP Push PDUs into a single message. The WAP Push module parses the WSP headers of these messages and uses the information they contain to forward the messages to the correct ALP components via the Exchange Manager.

Data Types

"application/x-wap-push"
"application/x-wap-push-http"
"application/x-wap-push-sec"
"application/x-wap-push-https"

Parameters

→ <fd data>: (file descriptor) The message to be forwarded.
→ POSTAL_SMS_EXGMGR_STORE_PARAM_URL: (string) The path to the file that stores the actual WAP Push message. This information is simply forwarded by WAP Push to other interested modules.
→ POSTAL_SMS_EXGMGR_STORE_PARAM_URL_LENGTH: (int) The length of the path to the file that stores the WAP Push message.
→ POSTAL_SMS_EXGMGR_STORE_PARAM_ORIGINATING_ADDRESS: (string) The originating address of the exchanged message.
→ POSTAL_SMS_EXGMGR_STORE_PARAM_ORIGINATING_ADDRESS_LENGTH: (int)The length of the originating address.

Returns

ALP_STATUS_OK: The operation completed successfully.
ALP_NOTIFY_CALLBACK_CANCEL: One or more parameters was invalid.
other error values: There was a problem completing the operation.

Bundle Exchange Server ^TOP^

ALP_EXG2_SEND_TOSTORAGE_VERB ^TOP^

Purpose

Accept one or more native bundles received from any source, including downloads, e-mail attachments, or receiving a file via OBEX from another device over IrDA or Bluetooth.

Data Types

ALP_BUNDLE_SCHEME_MIMETYPE_BAR
ALP_BUNDLE_SCHEME_EXTENSION_BAR

Parameters

→ <fd data>: (file descriptor) The native bundle(s) to be stored.

"bundle-send" ^TOP^

Purpose

Send a bundle to another device via a "store" request (which therefore can also trigger an OBEX transmission over IrDA or Bluetooth).

Data Types

ALP_BUNDLE_SCHEME_MIMETYPE_BAR
ALP_BUNDLE_SCHEME_EXTENSION_BAR

Parameters

→ <data_url>: (URL) The bundle name, in the form "bar:foo.bar.com". If not set, the exchange request will fail. The Bundle Exchange Server retrieves this value with a call to alp_exg_request_get_data_url().
→ "transport": (string, optional) If set, these are the transport parameters in the store request. If not set, a transport selector UI will be shown to the user.
→ "no-ui": (integer, optional) If set to a nonzero value, no UI will be shown (and thus no progress will be visible). By default the UI is shown.
→ "no-ui-error": (integer, optional) If set to a nonzero value, or if "no-ui" is set to zero (preventing the UI from being shown), if there is a problem wi