Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Chat
acceptChat()
cancelFileTransferByAgent()
declineChat()
endChat()
getAgentInput()
getAgentState()
getChatLog()
getChatRequests()
getDetailsByChatKey()
getDetailsByPrimaryTabId()
getEngagedChats()
getMaxCapacity()
initFileTransfer()
onAgentSend()
onAgentStateChanged()
onChatCanceled()
onChatCriticalWaitState()
onChatDeclined()
onChatEnded()
onChatRequested()
onChatStarted()
onChatTransferredOut()
onCurrentCapacityChanged()
onCustomEvent()
onFileTransferCompleted()
onNewMessage()
onTypingUpdate()
sendCustomEvent()
sendMessage()
setAgentInput()
setAgentState()
Methods for Chat Visitors
chasitor.addCustomEventListener()
chasitor.getCustomEvents()
chasitor.sendCustomEvent()
Methods for Omni-Channel
Other Resources
PDF

Newer Version Available

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

chasitor.sendCustomEvent()

Sends a custom event to the agent console of the agent who is currently chatting with a customer. Available in API version 29.0 or later.

Syntax

Arguments

Name Type Description
type string The name of the custom event to send to the agent console.
data string Additional data you want to send to the agent console along with the custom event.

Sample Code–Visualforce

Response

This method returns no responses.