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

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page >
18<apex:includeScript value="/support/console/29.0/integration.js"/>
19    <script type="text/javascript">
20        var eventHandler = function (result) {
21            alert('The chat request has been canceled for this chatKey: ' + result.chatKey);
22        }
23        sforce.console.chat.onChatCanceled(eventHandler);
24    </script>
25</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 Integration Toolkit Developer's Guide

onChatCanceled()

Syntax

Arguments

Sample Code–Visualforce

Response