Salesforce Console Integration Toolkit Developer Guide
jNewer Version Available
onAgentStateChanged()
Registers a function to call when agents change their Live Agent
status, such as from Online to Away. Available in API version 29.0 or
later.
Syntax
1sforce.console.chat.onAgentStateChanged(eventHandler:Function)Arguments
| Name | Type | Description |
|---|---|---|
| eventHandler | function | JavaScript method called when the agent's Live Agent status has changed. |
Sample Code–Visualforce
1<apex:page>
2 <apex:includeScript value="/support/console/29.0/integration.js"/>
3 <script type="text/javascript">
4 var eventHandler = function (result) {
5 alert("Agent's State has Changed to: " + result.state);
6 };
7 sforce.console.chat.onAgentStateChanged(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 |
|---|---|---|
| state | String | String that represents the agent’s current Live Agent status—for example, Online, Away, or Offline. |
| success | Boolean | true if firing event was successful; false if firing event wasn’t successful. |