Getting data
[Exchange Manager 2 Handlers]

Detailed Description

Handlers that can return data to the requester are based on ALP_EXG2_GET_ACTIONCLASS. Examples of methods are : get a vcard, take a picture or movie, record sound, select a file from media, etc.

Note that Getting data is different than Importing data. When getting data, the handler decides where it finds the data (file, database, hardware acquisition), whereas when importing, the handler always takes the data from the Filesystem.

The required data is returned as data objects in the response request.


Capture image or video

This verb is based on ALP_EXG2_GET_ACTIONCLASS. This service launches an application to capture a media file. The subject must be set to the type of the media you want to capture. This will typically be "image/jpeg" or some video type.

It is optionally possible to specify a filename where to store the captured file by passing a path in ALP_EXG2_AUDIO_FILEPATH_STRING_PARAM. If this parameter exists, its value is the path to store the recorded file. On output, the value is updated to be the full path to the recorded filename. This is useful when the requester just needs a reference to the file and not the actual data.

#define ALP_EXG2_AUDIO_FILEPATH_STRING_PARAM   "filePath"
 String parameter (optional) : path where to store recorded file.
#define ALP_EXG2_GET_CAPTURE_VERB   ALP_EXG2_GET_ACTIONCLASS"/capture"
 VERB: capture image or video file.

Get objects from storage : Contacts options

This describes the options available for ALP_EXG2_GET_FROMSTORAGE_VERB when you invoke it with the ALP_EXG2_CONTACTS_SUBJECT subject to use the Contacts services.

Here are all the options you can use to customize a get contact request:

  • ALP_EXG2_CONTACTS_CONTACT_TYPE_STRING_PARAM : [in,out] (optional) 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 (in contacts_dml.h) if you want any phone number and/or email

  • ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM : [in] (optional) If present, and non-zero, then the user will be allowed to select an entire category. Defaults to 0.

  • ALP_EXG2_CONTACTS_CONTACT_LUID_INT_PARAM : [out] If ALP_EXG2_CONTACTS_CONTACT_TYPE_STRING_PARAM specified, this is the Luid of the selected contact. 0 on errors or if user cancels selection.

  • ALP_EXG2_CONTACTS_FRIENDLY_NAME_STRING_PARAM : [out] If contactType specified, this is the friendly name of the selected contact.

  • ALP_EXG2_CONTACTS_CATEGORY_WAS_SELECTED_INT_PARAM : [out] If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM, this will tell you if a category was selected. 0 = No, 1 = Yes.

  • ALP_EXG2_CONTACTS_CATEGORY_SELECTED_INT_PARAM : [out] If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM and ALP_EXG2_CONTACTS_CATEGORY_WAS_SELECTED_INT_PARAM is 1, this will contain the category the user selected. 0 = All, -1 = Unfiled, otherwise the category ID.

  • ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM : [in] (optional) If present, and non-zero, then the user will be allowed to select a distribution group. Defaults to ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM. If ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_ONLY then only distribution groups can be selected.

  • ALP_EXG2_CONTACTS_DISTRIBUTION_CONTACT_TYPE_STRING_PARAM : [in] (optional) If present, used to limit the info returned to the desired distribution type. See contacts_dml.h for valid values.

  • ALP_EXG2_CONTACTS_DISTRIBUTION_WAS_SELECTED_INT_PARAM : [out] If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM, this will tell you if a distribution group was selected. 0 = No, 1 = Yes.

  • ALP_EXG2_CONTACTS_DISTRIBUTION_SELECTED_INT_PARAM : [out] [int] If ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM is non-zero and ALP_EXG2_CONTACTS_DISTRIBUTION_WAS_SELECTED_INT_PARAM is 1, this will contain the the distribution ID selected.

  • ALP_EXG2_IDENTIFIER_STRING_PARAM : Used to identify specify an existing item to act on.

  • ALP_EXG2_EDITABLE_INT_PARAM : Used to specify whether a displayed data item should be editable. The parameter should be an zero or nonzero.


#define ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM   "categoryOK"
 Int parameter (optional) : set to non-zero to allow the user to select an entire category.
#define ALP_EXG2_CONTACTS_CATEGORY_SELECTED_INT_PARAM   "categorySelected"
 Int parameter (returned) : category the user selected (0 = All, -1 = Unfiled, otherwise the category ID).
#define ALP_EXG2_CONTACTS_CATEGORY_WAS_SELECTED_INT_PARAM   "categoryWasSelected"
 Int parameter (returned) : If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM, this will tell you if a category was selected. 0 = No, 1 = Yes.
#define ALP_EXG2_CONTACTS_CONTACT_LUID_INT_PARAM   "contactLuid"
 Int parameter (returned) : this is the Luid of the selected contact. 0 on errors or user cancel.
#define ALP_EXG2_CONTACTS_CONTACT_TYPE_STRING_PARAM   "contactType"
 String parameter (optional / returned) : restrict picker to show this type of contact.
#define ALP_EXG2_CONTACTS_DISTRIBUTION_CONTACT_TYPE_STRING_PARAM   "distributionType"
 String parameter (optional) : If present, used to limit the info returned to the desired distribution type. See contacts_dml.h for valid values.
#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM   "distributionOK"
 Int parameter (optional) : if non zero, allow the user to select a distribution group.
#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_NO   0
#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_ONLY   2
#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_YES   1
#define ALP_EXG2_CONTACTS_DISTRIBUTION_SELECTED_INT_PARAM   "distributionSelected"
 Int parameter (returned) : If ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM is non-zero and ALP_EXG2_CONTACTS_DISTRIBUTION_WAS_SELECTED_INT_PARAM is 1, this will contain the distribution ID selected.
#define ALP_EXG2_CONTACTS_DISTRIBUTION_WAS_SELECTED_INT_PARAM   "distributionWasSelected"
 Int parameter (returned) : If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM, this will tell you if a distribution group was selected. 0 = No, 1 = Yes.
#define ALP_EXG2_CONTACTS_FRIENDLY_NAME_STRING_PARAM   "friendlyName"
 String parameter (optional) : If contactType specified, this is the friendly name of the selected contact.
#define ALP_EXG2_CONTACTS_SUBJECT   "application/vcf"
 SUBJECT: Get data from the Contacts database.
#define ALP_EXG2_EDITABLE_INT_PARAM   "editable"
 Used to specify whether a displayed data item should be editable. The parameter should be an zero or nonzero.
#define ALP_EXG2_IDENTIFIER_STRING_PARAM   "identifier"
 Used to identify specify an existing item to act on.

Get objects from storage : General

This verb is based on ALP_EXG2_GET_ACTIONCLASS. This service will show the necessary UI to let the user select data (from a database, file system, hardware...) of the type requested by the subject.

The data is then returned as a data object.

#define ALP_EXG2_GET_FROMSTORAGE_VERB   ALP_EXG2_GET_ACTIONCLASS"/storage"
 VERB: get from storage.

Define Documentation

#define ALP_EXG2_AUDIO_FILEPATH_STRING_PARAM   "filePath"
 

String parameter (optional) : path where to store recorded file.

#define ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM   "categoryOK"
 

Int parameter (optional) : set to non-zero to allow the user to select an entire category.

#define ALP_EXG2_CONTACTS_CATEGORY_SELECTED_INT_PARAM   "categorySelected"
 

Int parameter (returned) : category the user selected (0 = All, -1 = Unfiled, otherwise the category ID).

#define ALP_EXG2_CONTACTS_CATEGORY_WAS_SELECTED_INT_PARAM   "categoryWasSelected"
 

Int parameter (returned) : If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM, this will tell you if a category was selected. 0 = No, 1 = Yes.

#define ALP_EXG2_CONTACTS_CONTACT_LUID_INT_PARAM   "contactLuid"
 

Int parameter (returned) : this is the Luid of the selected contact. 0 on errors or user cancel.

#define ALP_EXG2_CONTACTS_CONTACT_TYPE_STRING_PARAM   "contactType"
 

String parameter (optional / returned) : restrict picker to show this type of contact.

#define ALP_EXG2_CONTACTS_DISTRIBUTION_CONTACT_TYPE_STRING_PARAM   "distributionType"
 

String parameter (optional) : If present, used to limit the info returned to the desired distribution type. See contacts_dml.h for valid values.

#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM   "distributionOK"
 

Int parameter (optional) : if non zero, allow the user to select a distribution group.

#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_NO   0
 

#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_ONLY   2
 

#define ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM_VALUE_YES   1
 

#define ALP_EXG2_CONTACTS_DISTRIBUTION_SELECTED_INT_PARAM   "distributionSelected"
 

Int parameter (returned) : If ALP_EXG2_CONTACTS_DISTRIBUTION_OK_INT_PARAM is non-zero and ALP_EXG2_CONTACTS_DISTRIBUTION_WAS_SELECTED_INT_PARAM is 1, this will contain the distribution ID selected.

#define ALP_EXG2_CONTACTS_DISTRIBUTION_WAS_SELECTED_INT_PARAM   "distributionWasSelected"
 

Int parameter (returned) : If ALP_EXG2_CONTACTS_CATEGORY_OK_INT_PARAM, this will tell you if a distribution group was selected. 0 = No, 1 = Yes.

#define ALP_EXG2_CONTACTS_FRIENDLY_NAME_STRING_PARAM   "friendlyName"
 

String parameter (optional) : If contactType specified, this is the friendly name of the selected contact.

#define ALP_EXG2_CONTACTS_SUBJECT   "application/vcf"
 

SUBJECT: Get data from the Contacts database.

#define ALP_EXG2_EDITABLE_INT_PARAM   "editable"
 

Used to specify whether a displayed data item should be editable. The parameter should be an zero or nonzero.

#define ALP_EXG2_GET_CAPTURE_VERB   ALP_EXG2_GET_ACTIONCLASS"/capture"
 

VERB: capture image or video file.

#define ALP_EXG2_GET_FROMSTORAGE_VERB   ALP_EXG2_GET_ACTIONCLASS"/storage"
 

VERB: get from storage.

#define ALP_EXG2_IDENTIFIER_STRING_PARAM   "identifier"
 

Used to identify specify an existing item to act on.

Generated on Wed Jul 30 07:06:44 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.