This class is mandatory for service provider applications within the AppKinetics system. This class also includes the programming interface for sending AppKinetics service responses. This interface would be utilized in the code of the listener of this class.
For an overall description of AppKinetics, see the icc package reference. To utilize this programming interface, the application must meet the requirements listed under Service Provider Requirements.
The methods in this interface cannot be used until BlackBerry Dynamics authorization processing is complete, see under GDAndroid.authorize.
- See also
- GDServiceError
-
GDServiceClient for the parts of the interface that are specific to service consumers.
-
GDAndroid.getServiceProvidersFor for the service discovery programming interface.
Call this method to respond to a consumer application from which an AppKinetics service request has been received. The response can include a results object and file attachments to be conveyed to the consumer application. The results object will notify the consumer of the success or failure of the request.
For an overall description of AppKinetics see the icc package reference.
If the request failed for any reason, pass a GDServiceError
as the results object. The GDServiceError
should be the result of calling one of the constructor functions with a suitable code for the error condition that caused the failure. Include any additional data by passing a suitable object as the details
parameter of the constructor. See GDServiceError for details.
If the request succeeded then pass a results object of a valid service parameter type, as defined under Service Parameters in the icc package reference.
- Parameters
-
application | String containing the native application idenitifer of the consumer, as supplied in the original service request. |
params | Object for the results object. |
option | GDICCForegroundOptions specifying the foreground execution preference after delivery of the response:
GDICCForegroundOptions.PreferPeerInForeground for the consumer application being in the foreground.
GDICCForegroundOptions.PreferMeInForeground for this application being in the foreground.
GDICCForegroundOptions.NoForegroundPreference to specify that there is no preference.
See also the notes under Foreground Execution in the icc package reference. |
attachments | Array of String objects containing the paths of files in the BlackBerry Dynamics secure file system that are to be attached to the response. See under File Attachments in the icc package reference. |
requestID | String containing the identifier of the service request to which this is a response. The identifier will have been passed as a parameter to the delegated handler that implements the service. |
- Exceptions
-