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

sforce.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

<apex:page >
    <apex:includeScript value="/support/console/68.0/integration.js"/>
    <script type="text/javascript">
        var eventHandler = function (result) {
            alert('A new engaged chat has started for this chatKey: ' + result.chatKey);
        }
        sforce.console.chat.onChatStarted(eventHandler);
    </script>
</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.