GDServiceRequestHandler Delegate

This callback is invoked when a service request is sent to the application within the BlackBerry Inter-Container Communication (ICC) system. The parameters with which this function is called give the details of the service request.

Namespace: GD
Assembly: GD (in GD.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public delegate void GDServiceRequestHandler(
	string srcApp,
	string serviceId,
	string version,
	string method,
	IDictionary<string, string> params,
	IList<IGDStorageFile> attachments,
	string requestId
)

public delegate void GDServiceRequestHandler(
	[InAttribute] String^ srcApp, 
	[InAttribute] String^ serviceId, 
	[InAttribute] String^ version, 
	[InAttribute] String^ method, 
	[InAttribute] IDictionary<String^, String^>^ params, 
	[InAttribute] IList<IGDStorageFile^>^ attachments, 
	[InAttribute] String^ requestId
)

function(srcApp, serviceId, version, method, params, attachments, requestId);

Parameters

srcApp: Type: SystemString
The BlackBerry Dynamics Entitlement identifier of the consumer application that sent the service request. The application is not required to check the value, but may do so. For example, the application could be coded only to process service requests from a known set of consumer applications, and to fail requests from unknown applications.
serviceId: Type: SystemString
The name of the service being requested. The application must check the value. If the application does not offer the requested service then the GDServicesErrorServiceNotFound code must be returned.
version: Type: SystemString
The version identifier of the service being requested. The application must check the value. If the application does not offer the requested service version then the GDServicesErrorServiceVersionNotFound code must be returned.
method: Type: SystemString
The name of the method within the service request. The application must check the value. If the application does not offer the requested method then the GDServicesErrorMethodNotFound code must be returned.
params: Type: System.Collections.GenericIDictionaryString, String
The service parameters in the request, sent by the consumer application. See under Service Parameters in the GDService class reference. If the service parameters are in some way invalid then a service-specific error code could be set, or this could be handled in some other way according to the service definition.
attachments: Type: System.Collections.GenericIListIGDStorageFile
Files that were attached to the service request. See under File Attachments in the GDService class reference. If the file attachments are in some way invalid then a service-specific error code could be set in the results object, or this could be handled in some other way according to the service definition.
requestId: Type: SystemString
The unique ID assigned to this service request by the ICC system. The application must pass this value as the requestID parameter in the GDService::SendResponseAsync(String, String, IDictionaryString, String, IListIGDStorageFile, GDServiceError) call if it responds to the request.

Remarks

For an overall description of ICC see the GDService class reference.

When this callback is invoked, the application must:

Check that the service request is valid.
Process the request, if valid.
If required by the service definition or other published API, respond to the request with a success or failure result by calling the GDService::SendResponseAsync(String, String, IDictionaryString, String, IListIGDStorageFile, GDServiceError) function.

Reference

GD Namespace