Salesforce Console Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
onAgentSend()
Registers a function to call when an agent sends a chat message through the Salesforce console. This method intercepts
the message and occurs before it is sent to the chat visitor. Available in API version 29.0 or
later.
Syntax
sforce.console.chat.onAgentSend(chatKey:String, callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| chatKey | String | The chatKey associated with the chat for which to call a function when the agent sends a message. |
| callback | function | JavaScript method called upon completion of the method. |
Sample Code–Visualforce
<apex:page >
<apex:includeScript value="/support/console/64.0/integration.js"/>
<script type="text/javascript">
var eventHandler = function (result) {
var theMessage = result.content;
alert('The agent is attempting to send the following message: ' + result.content);
sforce.console.chat.sendMessage(chatKey, theMessage)
alert('The following message has been sent: ' + theMessage);
}
//Get the value for 'myChatKey' from the sforce.console.chat.getDetailsByPrimaryTabId() or other chat methods.
//These values are for example purposes only
var chatKey = 'myChatKey';
sforce.console.chat.onAgentSend(chatKey, 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 |
|---|---|---|
| content | String | The text of the agent’s message. |
| name | String | The name of the agent who is attempting to send the message as it appears in the chat log. |
| type | String | The type of message that was received—for example, agent. |
| timestamp | Date/Time | The date and time the agent attempted to send the chat message. |
| success | Boolean | true if firing event was successful; false if firing event wasn’t successful. |