Bookshelf Home | Contents | Index | Search | PDF |
Siebel Communications Server Administration Guide > Developing a Communications Driver > Siebel Adaptive Communications API Reference >
Methods of ISC_SERVICE_HANDLE
The service handle, ISC_SERVICE_HANDLE, is implemented in the communications driver. Services are returned to the Siebel client in response to a call for the driver handle method RequestService. The service handle methods are called in order to communicate with the communications system—for example, to send commands and associated data. See RequestService.
When a call to a service handle method is successful, it returns 0 (zero). ISC_RESULT represents the API result type defined for the Siebel Adaptive Communications API.
When a call to a service method fails, the communications driver can call the client handle method HandleError to pass error data. See HandleError.
AcceptWorkItem
Accept a work item.
ISCAPI ISC_RESULT AcceptWorkItem
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING trackingID);HandleQueuedWorkItem
Handle a queued work item.
ISCAPI ISC_RESULT HandleQueuedWorkItem
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING name,
/* in */ const struct ISC_KVParamList* fields,
/* in */ const ISC_STRING trackingID);InvokeCommand
Invoke a command by name, using parameters. A basic ISC_SERVICE_HANDLE implementation should include at least the InvokeCommand method, in order to invoke named commands.
When this method is called, a command is invoked that is to be executed—for example, placing a call, transferring a call, or setting the Not Ready state. Most commands, but not all, are passed from the communications driver to the communications system.
ISCAPI ISC_RESULT InvokeCommand
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING clntCmdTrackID,
/* in */ const ISC_STRING name,
/* in */ const ISC_STRING stringParam,
/* in */ const struct ISC_KVParamList* datasetParam);InvokeCommandEx
Invoke a command by type, using parameters. The command type is represented by the value of the SCCommandTypeEx constant. You can use this method to invoke commands on an email server or CTI middleware server. The data structure ISC_KVParamList specifies the appropriate predefined parameters, according to the command type. For more information, see SCCommandTypeEx. See also the description for InvokeCommand.
ISCAPI ISC_RESULT InvokeCommandEx
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING clntCmdTrackID,
/* in */ enum SCCommandTypeEx commandType,
/* in */ const struct ISC_KVParamList* datasetParam);NotifyEventHandlingFinished
Notify the communications driver that the Siebel client has finished handling the event that was sent by the communications driver to the Siebel client using a call for the client handle method HandleEvent. See HandleEvent.
ISCAPI ISC_RESULT NotifyEventHandlingFinished
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING trackingID,
/* in */ ISC_BOOLEAN result);ReleaseISCServiceInstance
Release the service handle that was created using RequestService, and free resources. No subsequent calls to the driver handle will be made. The driver should in turn make no further calls to the client handle.
ISCAPI ISC_RESULT ReleaseISCServiceInstance
/* in */(ISC_SERVICE_HANDLE handle);ReleaseWorkItem
Release a work item.
ISCAPI ISC_RESULT ReleaseWorkItem
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING trackingID);ResumeWorkItem
Resume a work item.
ISCAPI ISC_RESULT ResumeWorkItem
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING trackingID);RevokeQueuedWorkItem
Revoke a queued work item.
ISCAPI ISC_RESULT RevokeQueuedWorkItem
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING trackingID);SuspendWorkItem
Suspend a work item.
ISCAPI ISC_RESULT SuspendWorkItem
/* in */(ISC_SERVICE_HANDLE handle,
/* in */ const ISC_STRING trackingID);
Bookshelf Home | Contents | Index | Search | PDF |
Siebel Communications Server Administration Guide Published: 23 June 2003 |