Newer Version Available

This content describes an older version of this product. View Latest

onChatCriticalWaitState()

Registers a function to call when a chat becomes critical to answer or a waiting chat is answered. Available in API version 29.0 or later.

Syntax

1sforce.console.chat.onChatCanceled(chatKey:String, callback:Function)

Arguments

Name Type Description
chatKey String The chatKey associated with the chat for which the critical wait state has changed.
callback function JavaScript method called upon completion of the method.

Sample Code–Visualforce

1<apex:page >
2    <apex:includeScript value="/support/console/62.0/integration.js"/>
3    <script type="text/javascript">
4        var eventHandler = function (result) {
5            alert('This chat has reached a critical wait');
6        }
7        //Get the value for 'myChatKey' from the sforce.console.chat.getDetailsByPrimaryTabId() or other chat methods. 
8        //These values are for example purposes only
9        var chatKey = 'myChatKey';
10        sforce.console.chat.onChatCriticalWaitState(chatKey, eventHandler);
11    </script>
12</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
state Boolean Indicates whether the chat is in critical wait state (true) or not (false).