This documentation lists those services and explain what they do, how they do it, and also how they can be customized by using certain parameters. The services are organized by action classes, except for one group of verbs that can only be used explicitly.
An action class defines a symbolic action. Methods are the different ways to perform the action. As methods can be selected interchangeably by the user, an application will build a request independently of the chosen verb. For this reason, it is necessary that all methods for a given action class all use the same conventions for parameters and data passing. Unless specified otherwise, the default conventions are to require zero mandatory request parameters and to pass or return data using data objects.
You are still allowed to define customization parameters to use in your handler, but they must be optional. This is because the requester may possibly invoke you blindly and have no idea of those parameters. But in case the requester invokes your handler specifically, it may be useful to pass additional information to customize the default behavior to something more elaborate.
The action class documentation can specifically state that its verbs need more parameters. In this case, requesters will have to set the parameters and your handler must use them to comply with the expected behavior.
If you are implementing a new service based on an existing action class, you must make it behave the same than the other existing services also based on that action class. This means : don't use an action class to create a verb that doesn't fit that symbolic action. If there is no suitable action class for your verb, feel free to create a new action class. Note however that this is necessary only in case there can be several methods to perform your new action. If your new verb is 'private', there is no need to base it on an action class.
Modules | |
| Sending data | |
| Getting data | |
| Viewing data or playing media | |
| Importing data from the Filesystem | |
| Exporting Data to the Filesystem | |
| Using a phone number | |
| Customized handlers | |
| DescriptionForXXXActionClass | |
Generic string parameter used by various verbs | |
| This parameter is used by various handlers. See exact meaning in each handler definition. | |
| #define | ALP_EXG2_GENERIC_STRING_PARAM "stringParam" |
| Generic string parameter. | |
|
|
Generic string parameter.
|
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.