Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
endChat()
Ends a chat in which an agent is currently engaged. Available in API version 29.0 or
later.
Syntax
1sforce.console.chat.endChat(chatKey:String, (optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| chatKey | String | The chat key for the engaged chat you wish to end. |
| 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 <a href="#" onClick="testEndChat();return false;">End Chat</a>
20
21 <script type="text/javascript">
22 function testEndChat() {
23 //Get the value for 'myChatKey'from the getEngagedChats() or onChatStarted() methods.
24 //These values are for example purposes only
25 var chatKey = 'myChatKey';
26 sforce.console.chat.endChat(chatKey, endSuccess);
27 }
28
29 function endSuccess(result) {
30 //Report whether ending the chat was succesful
31 if (result.success == true) {
32 alert('Ending the chat was successful');
33 } else {
34 alert('Ending the chat was not successful');
35 }
36 };
37 </script>
38</apex:page>