onChatStarted()

Registers a function to call when an agent starts a new chat with a customer. Available in API version 29.0 or later.

Usage

Syntax

1sforce.console.chat.onChatStarted(eventHandler:Function)

Arguments

Name	Type	Description
eventHandler	function	JavaScript method called when a chat request is accepted and becomes an engaged chat.

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('A new engaged chat has started for this chatKey: ' + result.chatKey);
22        }
23        sforce.console.chat.onChatStarted(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 become an engaged chat.
success	Boolean	`true` if firing event was successful; `false` if firing event wasn’t successful.