Salesforce Console Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
onChatStarted()
Registers a function to call when an agent starts a new chat with a customer. Available in API version 29.0 or
later.
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
1<apex:page >
2 <apex:includeScript value="/support/console/68.0/integration.js"/>
3 <script type="text/javascript">
4 var eventHandler = function (result) {
5 alert('A new engaged chat has started for this chatKey: ' + result.chatKey);
6 }
7 sforce.console.chat.onChatStarted(eventHandler);
8 </script>
9</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. |