Salesforce Console Developer Guide
jNewer Version Available
onTypingUpdate()
Registers a function to call when the customer’s text in the chat window
changes. If Sneak Peek is enabled, this function is called whenever the customer edits the
text in the chat window. If Sneak Peek is not enabled, this function is called whenever a
customer starts or stops typing in the chat window. Available in API version 29.0 or
later.
Syntax
1sforce.console.chat.onTypingUpdate(chatKey:String, callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| chatKey | String | The chatKey associated with the chat for which to call a function when a customer begins typing a new message to the agent. |
| callback | function | JavaScript method called upon completion of the method. |
Sample Code–Visualforce
1<apex:page >
2 <apex:includeScript value="/support/console/58.0/integration.js"/>
3 <script type="text/javascript">
4 var eventHandler = function (result) {
5 alert('There is a new typing update in this chat');
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.onTypingUpdate(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 |
|---|---|---|
| isTyping | Boolean | Indicates whether a chat visitor is typing (true) or not (false). |
| sneakPeek | String | The text the chat visitor is currently typing into their input box in the chat window. This is visible only if Sneak Peek is enabled for the agent. |
| success | Boolean | true if firing event was successful; false if firing event wasn’t successful. |