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

getEngagedChats()

Usage

Returns the chat keys of the chats in which the agent is currently engaged. Available in API version 29.0 or later.

Syntax

Arguments

Name Type Description
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
chatKey array Array of chatKey values, one for each of the currently engaged chats.
success boolean true if getting engaged chats was successful; false if getting engaged chats wasn’t successful.