Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

onChatCanceled()

Registers a function to call when a chat visitor cancels a chat request. Available in API version 29.0 or later.

Syntax

1sforce.console.chat.onChatCanceled(callback:Function)

Arguments

Name Type Description
callback function JavaScript method called upon completion of the method.

Sample Code–Visualforce

1<apex:page >
2<apex:includeScript value="/support/console/68.0/integration.js"/>
3    <script type="text/javascript">
4        var eventHandler = function (result) {
5            alert('The chat request has been canceled for this chatKey: ' + result.chatKey);
6        }
7        sforce.console.chat.onChatCanceled(eventHandler);
8    </script>
9</apex:page>

Response

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

Name Type Description
chatKey string The chat key for the chat request that has been canceled.