The cancel method is issued by the Java application to cancel a previously-requested
operation that is identified by its InvokeID.
The RequestID must match the InvokeID of the request that is to be canceled.
If they match and the operation is canceled, a dialogueFailureConfSend
with a status of E_OPERATION_CANCELLED must be sent.
If they match and the operation cannot be canceled, a dialogueFailureConfSend
with a status of E_OPERATION_NOT_CANCELLED must be sent.
If the IDs do not match, or the ID is no longer active, a dialogueFailureConfSend
with a status of E_INVALID_INVOKEID must be sent.
Syntax
CTICiscoReturn cancel();
Parameters
There are no parameters for this method.
Return properties
- Integer InvokeID
- An ID for this request that should be sent in the related dialogueFailureConfSend.
To extract this property, call the getInvokeID method on the returned CTICiscoReturn
object.
- Integer RequestID
- The InvokeID of the previously issued request that is to be canceled
as returned by the previous runScriptRequest. To extract this property, call
the getRequestID method on the returned CTICiscoReturn object.
- Integer Status
- Returns an Integer value from the list of status codes that describes
the result of this request (see Table 3.) To extract this
property, call the getStatus method on the CTICiscoReturn object.