Bookshelf Home | Contents | Index | PDF |
Siebel CTI Administration Guide > Developing a Communications Driver > Siebel Adaptive Communications API Reference > Methods of ISC_CLIENT_HANDLEThe client handle, ISC_CLIENT_HANDLE, is implemented by Oracle. The communications driver calls client handle methods in order to communicate with the Siebel application, such as to send communications events and associated data. When a call to a client handle method is successful, it returns 0 (zero). ISC_RESULT represents the API result type defined for the Siebel Adaptive Communications API. BeginBatchBegins a set of client methods to be invoked in a batch when the corresponding EndBatch method is invoked. Using these methods can reduce network overhead. Developers can use these methods at their discretion, subject to the driver implementation design. For more information, see EndBatch. ISC_RESULT (*BeginBatch) CacheCommandInformationNotifies the Siebel client about command-status caching. For the ith command in commandNames, the command description is at the ith position in commandDescriptions, and the command status is at the ith position in commandStatuses. The SCCommandFlags bit flags are used by commandStatuses. ISC_RESULT (*CacheCommandInformation) CleanAllWorkItemNotifies the Siebel client that all work items for this service session have been removed. ISC_RESULT (*CleanAllWorkItem) EndBatchEnds a set of client methods to be invoked in a batch when this method is invoked, given the use of the corresponding BeginBatch method to begin the batch. For more information, see BeginBatch. ISC_RESULT (*BeginBatch) HandleError
HandleEventHandles the named event received from the communications driver, using the given fields. By calling this method, the communications driver notifies the Siebel client of a communications event, such as a call coming in on the monitored teleset. If notifyWhenDone is set to True, then the communications driver is notified when event handling is finished. The event's ID is passed (using the trackingID parameter) in a call to the service handle method NotifyEventHandlingFinished. For more information, see NotifyEventHandlingFinished. ISC_RESULT (*HandleEvent) IndicateNewWorkItemIndicates a new incoming call by bringing the Siebel application to the front. If the end user has set the Enable Sound option in the User Preferences screen (Communications options), then the ringin.au file or another user-specified sound file plays. ISC_RESULT (*IndicateNewWorkItem) ShowStatusTextDisplays textual status information in the status line of the Siebel client. ISC_RESULT (*ShowStatusText) UpdateObjectInformationNotifies the Siebel application about status changes of communications objects, for example, that an agent has become busy. Notifications about DN status are used to keep track of when calls end and new calls start. For the object properties that can be provided using datasetInfo, see SCObjectProperty. ISC_RESULT (*UpdateObjectInformation) WorkItemReleasedAfter a work item has been released, such as a phone call disconnected, the driver calls this function. ISC_RESULT (*WorkItemReleased) WorkItemResumedAfter a work item has been resumed, such as a phone call resumed from hold at the switch, the driver calls this function. ISC_RESULT (*WorkItemResumed) WorkItemStartedAfter a work item has been started, such as a phone call connected, the driver calls this function. ISC_RESULT (*WorkItemStarted) WorkItemSuspendedAfter a work item has been suspended, such as a phone call put on hold at the switch, the driver calls this function. ISC_RESULT (*WorkItemSuspended) |
Siebel CTI Administration Guide | Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |