getEngagedChats()

Usage

Returns the chat keys of the chats in which the agent is currently engaged. Available in API version 29.0 or later.

Syntax

1sforce.console.chat.getEngagedChats(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");<apex:page>
2    <apex:includeScript value="/support/console/29.0/integration.js"/>
3    <a href="#" onClick="testGetEngagedChats();return false;">Get Engaged Chats</a> 
4
5    <script type="text/javascript">
6        function testGetEngagedChats() {
7            sforce.console.chat.getEngagedChats(function(result) {
8                if (result.success) {
9                    alert('Number Engaged Chats: ' + result.chatKey.length);
10                } else {
11                    alert('getEngagedChats has failed');
12                }
13            });
14        }
15    </script>
16</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	array	Array of chatKey values, one for each of the currently engaged chats.
success	boolean	`true` if getting engaged chats was successful; `false` if getting engaged chats wasn’t successful.

Salesforce Console Integration Toolkit Developer's Guide