Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

onTypingUpdate()

Usage

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

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

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.