Customized handlers
[Exchange Manager 2 Handlers]


Detailed Description

This section groups all customized handlers. Customized handlers are not based on an action class, and they don't adhere to any convention for data and parameter passing. Each handler in this group must define its own parameters and behavior.

Handlers in this group cannot be dynamically discovered. A requester that want to use one of these services must therefore explicitly invoke the required verb, subject and add all request parameters as required by the definition.


Open a URL in browser

This handler will start the browser application and open an url in browser. The subject must be set to ALP_EXG2_URLSTRING_SUBJECT.

The url string must be passed in the ALP_EXG2_GENERIC_STRING_PARAM string param.

#define ALP_EXG2_BROWSER_OPEN_URL_VERB   "Open"
 VERB: Open a URL in browser.

Dial the emergency service

The service will dial the emergency service.

#define ALP_EXG2_DIAL_EMERGENCY_SUBJECT   "dial_emergency"
 SUBJECT: Dial the emergency service.
#define ALP_EXG2_DIAL_EMERGENCY_VERB   "dialEmergency"
 VERB: Dial the emergency service.

Dial the voicemail service

The service will dial the voicemail service.

#define ALP_EXG2_DIAL_VOICEMAIL_SUBJECT   "dial_voicemail"
 SUBJECT: Dial the voicemail service.
#define ALP_EXG2_DIAL_VOICEMAIL_VERB   "dialVoicemail"
 VERB: Dial the voicemail service.

Download the content of a URL in download mgr

This handler will start the download mgr application and download the content of an url in download mgr. The subject must be set to ALP_EXG2_URLSTRING_SUBJECT.

The url string must be passed in the ALP_EXG2_GENERIC_STRING_PARAM string param.

#define ALP_EXG2_DOWNLOAD_URL_VERB   "alp_download"
 VERB: Download the content of a URL in download mgr.

View email attention item

This handler will start the email application and jump to the Inbox of the account for which the attn item was generated for The subject must be set to ALP_EXG2_EMAIL_ATTENTION_SUBJECT.

#define ALP_EXG2_EMAIL_ATTENTION_ACCOUNT_ID_INT_PARAM   "email_attention_account_id"
 PARAM: Email attention item accountId.
#define ALP_EXG2_EMAIL_ATTENTION_SERVICE_ID_INT_PARAM   "email_attention_service_id"
 PARAM: Email attention item serviceId.
#define ALP_EXG2_EMAIL_ATTENTION_SUBJECT   "email_attention_subject"
 SUBJECT: Email attention item subject.
#define ALP_EXG2_EMAIL_VIEW_ATTENTION_VERB   "email_attention_verb"
 VERB: View email attention item.

Start a Chat

This handler will start the IM application. The subject must be set to ALP_EXG2_EMAILSTRING_SUBJECT.

The Chat will be started with the buddy whose email is passed in the ALP_EXG2_GENERIC_STRING_PARAM string param.

#define ALP_EXG2_IM_START_CHAT_VERB   "Chat"
 VERB: Start a Chat.

Launch PictureViewer in Grid view mode

This handler will launch Picture Viewer with grid view mode. No input parameters are required and no return values as well.

#define ALP_EXG2_PHOTOS_LIST_VIEW_SUBJECT   "application/img"
 SUBJECT: Go to the grid view mode of all the images.
#define ALP_EXG2_PHOTOS_LIST_VIEW_VERB   "photos_view_list"
 VERB: Go to the grid view mode of all the images.

Play stream content from a URL

This handler will start the PVPlayer application and play the content from an URL. The subject must be set to ALP_EXG2_RTSPURLSTRING_SUBJECT.

The url string must be passed in the ALP_EXG2_GENERIC_STRING_PARAM string param.

#define ALP_EXG2_PLAY_STREAM_FROM_URL_VERB   "play_stream_from_url"
 VERB: Play stream content from a URL.

Launch Prefpanel/Security to accept a certificate

This handler will start the Prefpanel/Security application and display install/accept cert dialog if a browser or email app hits a server with an expired or self-signed cert.

The supported subject are: "application/x-x509-ca-cert", "application/x-x509-user-cert", "application/pkcs12", "application/x-pkcs12", "application/x-x509-email-cert", ".p12", ".pfx", ".cer", ".pem", ".crt".

This handler has the same param than verb ALP_EXG2_SECU_CERT_STORE_VERB The certificate must be contained in a file whose filename is passed in a ALP_EXG2_SECU_CERT_FILENAME_STR_PARAM string parameter or must be contained as binary data which is passed in a ALP_EXG2_SECU_CERT_DATA_BLOB_PARAM blob parameter.

The handler will return the result state in the ALP_EXG2_SECU_RESULT_INT_PARAM int parameter:

  • 0 - Reject or fail to accept/save.
  • 1 - Accept Once Successfully.
  • 2 - Accept & Save Successfully.
  • 4 - Existed (the cerificate existed).


#define ALP_EXG2_SECU_CERT_ACCEPT_VERB   "accept"
 VERB: Display Prefpanel/Security certificate accept dialog.

Launch Prefpanel/Security to install a certificate

This handler will start the Prefpanel/Security application and display install cert dialog.

The supported subject are: "application/x-x509-ca-cert", "application/x-x509-user-cert", "application/pkcs12", "application/x-pkcs12", "application/x-x509-email-cert", ".p12", ".pfx", ".cer", ".pem", ".crt".

The certificate must be contained in a file whose filename is passed in a ALP_EXG2_SECU_CERT_FILENAME_STR_PARAM string parameter or must be contained as binary data which is passed in a ALP_EXG2_SECU_CERT_DATA_BLOB_PARAM blob parameter.

The handler will return the result state in the ALP_EXG2_SECU_RESULT_INT_PARAM int parameter.

  • 0 - Cancel or fail to install.
  • 1 - installed Successfully.


#define ALP_EXG2_SECU_CERT_APPNAME_STR_PARAM   "appname"
 String send parameter : appname(which application lanuch the verb).
#define ALP_EXG2_SECU_CERT_DATA_BLOB_PARAM   "data"
 Blob send parameter : data(it is contained all certicate binary data).
#define ALP_EXG2_SECU_CERT_FILENAME_STR_PARAM   "filename"
 String send parameter : filename(certificate filename with path).
#define ALP_EXG2_SECU_CERT_RESULT_INT_PARAM   "mode"
 Mandatory send int parameter : mode(0: blocking - receive data and show install/accept dialog 1:unblocking - only receive data then return).
#define ALP_EXG2_SECU_CERT_STORE_VERB   "store"
 VERB: Display Prefpanel/Security certificate install dialog.

Verify DeviceLock state and unlock with password or enter into Emergency Call

This handler will verify if device is locked. If it is locked, it will ask the required password to the user or enter into Emergency Call.

The subject must be set to ALP_EXG2_SECU_VERIFY_SUBJECT.

The handler will return the result state in the ALP_EXG2_SECU_RESULT_INT_PARAM int parameter.

  • 0 - password verified successfully;
  • 1 - Entered into Emergency Call;
  • 2 - Cancel the verify dialog;


#define ALP_EXG2_SECU_RESULT_INT_PARAM   "result"
 returned int parameter : result
#define ALP_EXG2_SECU_VERIFY_SUBJECT   "application/x-text"
 SUBJECT: Display Prefpanel/Security subject.
#define ALP_EXG2_SECU_VERIFY_VERB   "verify"
 VERB: Display Prefpanel/Security Password verify dialog.

View Prefpanel/Security Certificates dialog

This handler will display Certificates dialog when it is launched by browser.

The subject must be set to ALP_EXG2_SECU_VERIFY_SUBJECT.

#define ALP_EXG2_SECU_VIEW_VERB   "view"
 VERB: Display Prefpanel/Security Certificate page.

Launch SMS/MMS to compose a message

This handler will start the SMS+ application to compose message. The subject must be set to ALP_EXG2_PHONESTRING_SUBJECT.

If the ALP_EXG2_GENERIC_STRING_PARAM string param exists and is not empty, the message destination number will be pre-filled with the value of this parameter (should be a phone number).

If the ALP_EXG2_SMS_MMS_BODYTEXT_STRING_PARAM string param exists and is not empty, the message body text will be pre-filled with this string.

If the ALP_EXG2_SMS_MMS_SERVICEID_INT_PARAM int param exists, its value tells which type of message must be composed:

  • The value ALP_POSTAL_SERVICE_ID_MMS will select to compose an MMS.
  • The value ALP_POSTAL_SERVICE_ID_SMS will select to compose an SMS (default if parameter not given).

NOTE: If ALP_EXG2_SMS_MMS_SERVICEID_INT_PARAM set as ALP_POSTAL_SERVICE_ID_SMS, ALP_EXG2_SMS_MMS_PHONENUM_STRING_PARAM exists and is not empty, the string defined by ALP_EXG2_SMS_MMS_BODYTEXT_STRING_PARAM will send as SMS directly without SMS+ compose window shown.

#define ALP_EXG2_SMS_MMS_BODYTEXT_STRING_PARAM   "smsBodyText"
 Optional string parameter : the text of sms or the text in first page of mms.
#define ALP_EXG2_SMS_MMS_COMPOSE_VERB   "compose_sms+"
 VERB: Compose SMS/MMS.
#define ALP_EXG2_SMS_MMS_SERVICEID_INT_PARAM   "smsServiceId"
 Optional int parameter : if value is ALP_POSTAL_SERVICE_ID_SMS, an SMS compose form is displayed. If the value is ALP_POSTAL_SERVICE_ID_MMS. an MMS compose form is displayed.

Display SMS/MMS using a record id

This handler will start the messaging application and display an SMS or MMS from the database. The subject must be set to ALP_EXG2_SMS_MMS_VIEWBYLUID_SUBJECT.

The record id must be passed in the ALP_EXG2_SMS_MMS_LUID_INT_PARAM int param.

#define ALP_EXG2_SMS_MMS_LUID_INT_PARAM   "smsMmsLuid"
 Mandatory int parameter : record id.
#define ALP_EXG2_SMS_MMS_VIEWBYLUID_SUBJECT   "ps_reference_sms"
 SUBJECT: Display SMS/MMS using a record id.
#define ALP_EXG2_SMS_MMS_VIEWBYLUID_VERB   "view_by_luid_SMS+"
 VERB: Display SMS/MMS using a record id.

stop and quit the voice recorder application by the caller

Apps will generally stop recording and quit the voice recorder, eg. when the phone call ends, the phone recorder should be stopped.

#define ALP_EXG2_VOICERECORDER_STOP_VERB   "voicerecorder_stop"
 VERB: quit the voice recorder.


Define Documentation

#define ALP_EXG2_BROWSER_OPEN_URL_VERB   "Open"
 

VERB: Open a URL in browser.

#define ALP_EXG2_DIAL_EMERGENCY_SUBJECT   "dial_emergency"
 

SUBJECT: Dial the emergency service.

#define ALP_EXG2_DIAL_EMERGENCY_VERB   "dialEmergency"
 

VERB: Dial the emergency service.

#define ALP_EXG2_DIAL_VOICEMAIL_SUBJECT   "dial_voicemail"
 

SUBJECT: Dial the voicemail service.

#define ALP_EXG2_DIAL_VOICEMAIL_VERB   "dialVoicemail"
 

VERB: Dial the voicemail service.

#define ALP_EXG2_DOWNLOAD_URL_VERB   "alp_download"
 

VERB: Download the content of a URL in download mgr.

#define ALP_EXG2_EMAIL_ATTENTION_ACCOUNT_ID_INT_PARAM   "email_attention_account_id"
 

PARAM: Email attention item accountId.

#define ALP_EXG2_EMAIL_ATTENTION_SERVICE_ID_INT_PARAM   "email_attention_service_id"
 

PARAM: Email attention item serviceId.

#define ALP_EXG2_EMAIL_ATTENTION_SUBJECT   "email_attention_subject"
 

SUBJECT: Email attention item subject.

#define ALP_EXG2_EMAIL_VIEW_ATTENTION_VERB   "email_attention_verb"
 

VERB: View email attention item.

#define ALP_EXG2_IM_START_CHAT_VERB   "Chat"
 

VERB: Start a Chat.

#define ALP_EXG2_PHOTOS_LIST_VIEW_SUBJECT   "application/img"
 

SUBJECT: Go to the grid view mode of all the images.

#define ALP_EXG2_PHOTOS_LIST_VIEW_VERB   "photos_view_list"
 

VERB: Go to the grid view mode of all the images.

#define ALP_EXG2_PLAY_STREAM_FROM_URL_VERB   "play_stream_from_url"
 

VERB: Play stream content from a URL.

#define ALP_EXG2_SECU_CERT_ACCEPT_VERB   "accept"
 

VERB: Display Prefpanel/Security certificate accept dialog.

#define ALP_EXG2_SECU_CERT_APPNAME_STR_PARAM   "appname"
 

String send parameter : appname(which application lanuch the verb).

#define ALP_EXG2_SECU_CERT_DATA_BLOB_PARAM   "data"
 

Blob send parameter : data(it is contained all certicate binary data).

#define ALP_EXG2_SECU_CERT_FILENAME_STR_PARAM   "filename"
 

String send parameter : filename(certificate filename with path).

#define ALP_EXG2_SECU_CERT_RESULT_INT_PARAM   "mode"
 

Mandatory send int parameter : mode(0: blocking - receive data and show install/accept dialog 1:unblocking - only receive data then return).

#define ALP_EXG2_SECU_CERT_STORE_VERB   "store"
 

VERB: Display Prefpanel/Security certificate install dialog.

#define ALP_EXG2_SECU_RESULT_INT_PARAM   "result"
 

returned int parameter : result

#define ALP_EXG2_SECU_VERIFY_SUBJECT   "application/x-text"
 

SUBJECT: Display Prefpanel/Security subject.

#define ALP_EXG2_SECU_VERIFY_VERB   "verify"
 

VERB: Display Prefpanel/Security Password verify dialog.

#define ALP_EXG2_SECU_VIEW_VERB   "view"
 

VERB: Display Prefpanel/Security Certificate page.

#define ALP_EXG2_SMS_MMS_BODYTEXT_STRING_PARAM   "smsBodyText"
 

Optional string parameter : the text of sms or the text in first page of mms.

#define ALP_EXG2_SMS_MMS_COMPOSE_VERB   "compose_sms+"
 

VERB: Compose SMS/MMS.

#define ALP_EXG2_SMS_MMS_LUID_INT_PARAM   "smsMmsLuid"
 

Mandatory int parameter : record id.

#define ALP_EXG2_SMS_MMS_SERVICEID_INT_PARAM   "smsServiceId"
 

Optional int parameter : if value is ALP_POSTAL_SERVICE_ID_SMS, an SMS compose form is displayed. If the value is ALP_POSTAL_SERVICE_ID_MMS. an MMS compose form is displayed.

#define ALP_EXG2_SMS_MMS_VIEWBYLUID_SUBJECT   "ps_reference_sms"
 

SUBJECT: Display SMS/MMS using a record id.

#define ALP_EXG2_SMS_MMS_VIEWBYLUID_VERB   "view_by_luid_SMS+"
 

VERB: Display SMS/MMS using a record id.

#define ALP_EXG2_VOICERECORDER_STOP_VERB   "voicerecorder_stop"
 

VERB: quit the voice recorder.


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.