Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide
10-11
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 10 Call Object
Methods
ClearConnection
If there are only two parties to the call, ClearConnection effectively clears the call. However, for a
multi-party conference call, only the one connection is dropped, which will be its own connection.
multi-party conference call, only the one connection is dropped, which will be its own connection.
Syntax
C++:
int ClearConnection()
int ClearConnection(Arguments & reserved_args);
COM:
HRESULT ClearConnection (/*[in,optional]*/ IArguments *reserved_args, (/*[out,
retval]*/ int * errorcode)
VB:
ClearConnection([reserved_args As IArguments]) As Long
Java:
int ClearConnection(Arguments rArgs);
.NET:
CilError ClearConnection(Arguments args);
Parameters
reserved_args
Not currently used, reserved for future use.
errorcode
An output parameter (return parameter in VB) that contains an error code from
in
Return Value
Default CTI OS return values. See
Remarks
As with the Clear method, under certain switches the ClearConnection request must be made via a call
whose status is LCS_CONNECT or LCS_INITIATE or it will fail. Many other switches allow the Clear
method to be called via a call whose status is LCS_ALERTING or LCS_HOLD. It may never be made
via a call whose status is LCS_NULL indicating that it has already been cleared.
whose status is LCS_CONNECT or LCS_INITIATE or it will fail. Many other switches allow the Clear
method to be called via a call whose status is LCS_ALERTING or LCS_HOLD. It may never be made
via a call whose status is LCS_NULL indicating that it has already been cleared.
The following events will be received if this request is successful:
•
OnClearConnectionConf event
•
OnCallConnectionlCleared event
If this is a two party call, these events will be followed by
•
OnCallCleared event
The following events will be received if this request fails:
•
OnControlFailureConf event