|
||||||||||||||||||||||||||||||||||||||||||||
CompatibilityImplemented only if 4.0 New Feature Set is present.
|
version |
The version number for this structure. The current version is 1. |
actionCode |
The action that the helper application should perform. See Table 36.1. |
data |
Data specific to the action code. See Table 36.1. |
The HelperNotifyEventType structure specifies which action is to be performed and contains data necessary for that action. All actions have some common data. Actions also have data specific to that action. The specific data uses a union that is part of the HelperNotifyEventType structure.
Implemented only if 4.0 New Feature Set is present.
The HelperNotifyExecuteType structure identifies the service to perform and contains the data necessary to perform that service. This structure is used as the data field of the HelperNotifyEventType structure when the action code is kHelperNotifyActionCodeExecute.
typedef struct HelperNotifyExecuteTypeTag { UInt32 serviceClassID; UInt32 helperAppID; Char *dataP; Char *displayedName; void *detailsP; Err err; } HelperNotifyExecuteType;
serviceClassID |
The ID of the service to be performed. See Helper Service Class IDs. |
helperAppID |
The unique ID of the helper; a value of 0 indicates that any available helper for the specified service class should perform the service. |
dataP |
A null-terminated string specific to this service, such as a phone number for the dial service or an email address for the email service. See Table 36.2. Multiple fields must be separated by semicolons (;). |
displayedName |
A null-terminated string containing an optional, human-readable description of the string in dataP. For example, if dataP contains a phone number, this field might contain the name of the person at that number. |
detailsP |
A pointer to a data structure containing extra information that this service requires. See Table 36.2. If the service does not require extra information, this field is NULL. |
err |
An error code that indicates if the service was performed successfully or not. If the service was successful, this field contains errNone, and the handled field in the notification data structure should be set to true. |
The following table lists the Palm OS-defined values for the service class ID and for each service, shows what value dataP contains and what type of structure detailsP points to.
Implemented only if 4.0 New Feature Set is present.
The HelperNotifyValidateType structure identifies a service that should be validated and the helper that should validate it. This structure is used as the data field of the HelperNotifyEventType structure when the action code is kHelperNotifyActionCodeValidate.
typedef struct HelperNotifyValidateTypeTag { UInt32 serviceClassID; UInt32 helperAppID; } HelperNotifyValidateType;
serviceClassID |
The ID of the service to be validated. See Helper Service Class IDs. |
helperAppID |
The creator ID of the helper application. 0 indicates that any available helper for the specified service should respond. If nonzero, only the helper with the matching creator ID should respond. |
The helper returns true in the handled field of the SysNotifyParamType structure to indicate that the service can be performed or false to indicate that the service cannot be performed.
Implemented only if 4.0 New Feature Set is present.
The HelperServiceEMailDetailsType structure provides additional data for the email service. It is used as the detailsP field in the HelperNotifyExecuteType when the service class ID is kHelperServiceClassIDEMail.
typedef struct _HelperServiceEMailDetailsType { UInt16 version; Char *cc; Char *subject; Char *message; } HelperServiceEMailDetailsType;
Implemented only if 4.0 New Feature Set is present.
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.
typedef struct _HelperServiceSMSDetailsType { UInt16 version; Char *message; } HelperServiceSMSDetailsType;
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. |
Implemented only if 4.0 New Feature Set is present.
The header file HelperServiceClass.h defines the constants listed in Table 36.3 as service class IDs. Third party developers may define their own service classes. To do so, you must register a 32-bit identifier with Palm, Inc. on this web site:
http://www.palmos.com/dev/tech/palmos/creatorid/
Alternatively, you can use a creator ID that you already own.
Implemented only if 4.0 New Feature Set is present.
|