Salesforce Console Integration Toolkit Developer's Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
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()
chasitor.addCustomEventListener()
chasitor.getCustomEvents()
chasitor.sendCustomEvent()
Glossary
Newer Version Available
Methods for Live Agent Chat Visitors
There are a few methods available that you can use to customize the chat visitor
experience for Live Agent in a custom Visualforce chat window.
-
chasitor.addCustomEventListener()
Registers a function to call when a custom event is received in the chat window. Available in API version 29.0 or later. -
chasitor.getCustomEvents()
Retrieves a list of custom events that have been received in this chat window during this chat session. Available in API version 29.0 or later. -
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.