Conversation Toolkit API

lightning:conversationToolkitAPI

Work with Live Agent in a Lightning console app.

For Use In

Lightning Experience

The lightning:conversationToolkitAPI component provides methods to interact with a chat visitor.

Methods

This component supports the methods for Chat for the Salesforce Console.

Name	Description	Type	Default	Required
body	The body of the component. In markup, this is everything in the body of the tag.	Aura.Component[]

Name	Description	Argument Name	Argument Type	Argument Description
cancelFileTransfer	Cancels a file transfer request has been sent to the customer	arguments	Object	Argument object with values for [recordId]
endChat	Ends a chat in which an agent is currently engaged.	arguments	Object	Argument object with value for [recordId]
getChatLog	Gets the chat log.	arguments	Object	Argument object with values for [recordId]
getDetailsByRecordId	Gets the details regarding the chasitor engaged in the given recordId	arguments	Object	Argument object with values for [recordId]
initFileTransfer	Initiates the process of transferring a file from a customer to an agent	arguments	Object	Argument object with values for [recordId] and [attachmentRecordId]
sendCustomEvent	Sends a custom event to the client-side chat window	arguments	Object	Argument object with values for [recordId], [type], and [data]
sendMessage	Sends a new chat message from the agent	arguments	Object	Argument object with values for [recordId] and [message]
setAgentInput	Sets the text in the agent's text box	arguments	Object	Argument object with values for [recordId] and [message]