This chapter documents those APIs that you employ when using the standard helper services included in Palm OS. The material in this chapter is divided up as follows:
Helper Service Class Structures and Types
Helper Service Class Constants
The header file HelperServiceClass.h
declares the API that this chapter describes.
For more information on using the Helper API, see the section "Helper Notifications" and Chapter 9, "Helper."
Helper Service Class Structures and Types
HelperServiceEMailDetailsType Struct
Purpose
Provides additional data for the email service. It is used as the detailsP
field in the HelperNotifyExecuteType
when the service class ID is kHelperServiceClassIDEMail
.
Declared In
HelperServiceClass.h
Prototype
typedef struct _HelperServiceEMailDetailsType { uint16_t version; Char *cc; Char *subject; Char *message; } HelperServiceEMailDetailsType
Fields
-
version
- The version number for this structure. The current version is 1.
-
cc
- A null-terminated string containing an email address that should be sent a carbon copy of the message. Multiple addresses are separated by a semi-colon (;). May be
NULL
if there are no email addresses to carbon copy. -
subject
- A null-terminated string containing the subject line. May be
NULL
. -
message
- Initial message body string or
NULL
.
HelperServiceSMSDetailsType Struct
Purpose
The HelperServiceSMSDetailsType
structure provides the SMS message to be sent. It is used as the detailsP
field in the HelperNotifyExecuteType
when the service class ID is kHelperServiceClassIDSMS
.
Declared In
HelperServiceClass.h
Prototype
typedef struct _HelperServiceSMSDetailsType { uint16_t version; Char *message; } HelperServiceSMSDetailsType
Fields
-
version
- The version number for this structure. The current version is 1.
-
message
- A null-terminated string containing the body of the message to be sent, or
NULL
.
Helper Service Class Constants
Helper Service Class IDs
Purpose
Identify the service that the helper performs. Pass one of these service class IDs within a HelperNotifyValidateType
structure when validating the existence of a service, or within a HelperNotifyExecuteType
when requesting that the service be performed. When enumerating possible services, the returned HelperNotifyEnumerateListType
structures contain service class IDs to identify the services that they perform.
Declared In
HelperServiceClass.h
Constants
-
#define kHelperServiceClassIDEMail 'mail'
- Send an email message.
dataP
points to the email address to which the message is to be sent, whiledetailsP
points to a structure of typeHelperServiceEMailDetailsType
. -
#define kHelperServiceClassIDFax 'fax_'
- Send a fax.
dataP
points to the fax number to which the fax is to be sent, whiledetailsP
isNULL
. -
#define kHelperServiceClassIDSMS 'sms_'
- Send an SMS message.
dataP
points to the SMS mailbox number to which the message is to be sent, whiledetailsP
points to a structure of typeHelperServiceSMSDetailsType
. -
#define kHelperServiceClassIDVoiceDial 'voic'
- Dial a phone number for a voice telephone call.
dataP
points to the telephone number to dial, whiledetailsP
isNULL
.
Comments
Third party developers may define their own service classes. To do so, you must register a 32-bit identifier with PalmSource, Inc. on this web site:
http://www.palmos.com/dev/creatorid/
Alternatively, you can use a creator ID that you already own.