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/58.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.

Salesforce Console Developer Guide

onChatCanceled()

Syntax

Arguments

Sample Code–Visualforce

Response