| GDServiceClientSendRequestAsync Method |
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.
Namespace:
GD
Assembly:
GD (in GD.dll) Version: 255.255.255.255
Syntax public IAsyncOperation<bool> SendRequestAsync(
string targetApp,
string serviceId,
string version,
string method,
IDictionary<string, string> params,
IList<IGDStorageFile> attachments,
out string requestId
)
public:
virtual IAsyncOperation<bool>^ SendRequestAsync(
[InAttribute] String^ targetApp,
[InAttribute] String^ serviceId,
[InAttribute] String^ version,
[InAttribute] String^ method,
[InAttribute] IDictionary<String^, String^>^ params,
[InAttribute] IList<IGDStorageFile^>^ attachments,
[OutAttribute] String^% requestId
) sealed
function SendRequestAsync(targetApp, serviceId, version, method, params, attachments, requestId);
Parameters
- targetApp
- Type: SystemString
The native bundle identifier of the service provider application. A suitable value could be obtained from the Address property of a [!:GDAppDetail] object returned by the GDWindows::GetServiceProvidersAsync(GDServiceProviderType, String, String) method. - serviceId
- Type: SystemString
The ID of the service to which the request is being sent. The value should correspond to a service that the service provider application offers. - version
- Type: SystemString
Version identifier of the service being requested. The value should correspond to a version of service that the service provider application offers. - method
- Type: SystemString
Method, within the service, that is being requested. The value should correspond to the name of a method that the service provider application offers. - params
- Type: System.Collections.GenericIDictionaryString, String
The service parameters key-value map for the request. See under Service Parameters in the GDService class reference. - attachments
- Type: System.Collections.GenericIListIGDStorageFile
Files in the BlackBerry Dynamics secure file system that are to be attached to the request. See under File Attachments in the GDService class reference. - requestId
- Type: SystemString
Output parameter for returning the unique ID assigned to the request by the ICC system.
Return Value
Type:
IAsyncOperationBooleanWhen this method completes and the request was accepted by the ICC system, it returns true; otherwise false.
The result of the service request could be notified to the application by invocation of its HandleResponse event, depending on the service, and whether the request is able to be delivered.
Remarks For an overall description of ICC see the GDService class reference.
The ICC system will assign a unique ID to the service request and make this available to the application. This value will also be returned with any response to the request. An application that makes multiple concurrent requests can use the request ID to match responses with requests.
See Also