 | GDServiceClient Class |
This class is mandatory for service consumer applications within the BlackBerry Inter-Container Communication (ICC) system. This class also includes the specific API for sending ICC service requests.
Inheritance HierarchyNamespace: GD
Assembly: GD (in GD.dll) Version: 255.255.255.255
Syntaxpublic sealed class GDServiceClient
The GDServiceClient type exposes the following members.
Properties
Methods| Name | Description | |
|---|---|---|
 | Equals | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| SendRequestAsync | Call this method to send a service request to a service provider application in the BlackBerry Inter-Container Communication (ICC) system. The request includes a method name, and can include service parameters and file attachments to be conveyed to the provider application. |
| ToString | (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | HandleResponse | This callback is invoked when a response is received to a service request that was sent within the ICC system. |
| HandleSendingFailed | This event is invoked whenever the delivery of service request via the BlackBerry ICC system fails. |
| HandleSendingFinished | This event is invoked whenever the delivery of a service request via the BlackBerry ICC system completes. |
| HandleSendingPayloadStarted | This callback is invoked whenever transfer of BlackBerry ICC payload file to service provider starts. |
| HandleSendingStarted | This event is invoked whenever transfer of BlackBerry ICC payload file to service provider starts. |
RemarksTo utilize this API the application must meet the requirements listed under Service Consumer Requirements, below.
For an overall description of ICC see the GDService class reference.
The functions in this API cannot be used until BlackBerry Dynamics authorization processing is complete, see under GDWindows::Authorize.
SERVICE CONSUMER REQUIREMENTS
To function as an ICC service consumer, a BlackBerry Dynamics application must:
- Access object of the GDServiceClient class using Instance property.
- Register event handlers from GDServiceClient class that application is interested in.
- Register the ICC URL type on the device. This will normally be achieved by utilizing the mandatory BlackBerry Dynamics build-time configuration, as detailed in the GDWindows class reference.
Note that an application that consumes multiple services still instantiates only a single object of this class. The HandleResponse delegate of the object handles responses from all the services that the application consumes.
See Also