Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
How are the Classic and Lightning Console APIs Different?
Lightning Console JavaScript API
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Pop-Out Utilities
Using Events with the Lightning Console JavaScript API
Use Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods
Methods for Navigation Items
Methods for Workspace Tabs and Subtabs
Methods for the Utility Bar
LWC Methods for Enhanced Messaging
endConversation()
getConversationLog()
getEnhancedConversationLog()
inactivateConversation()
sendTextMessage()
setAgentInput()
setMessagingComponent()
sendMessagingComponent()
Aura Methods for Enhanced Messaging
Methods for Chat
Methods for Omni-Channel
Events
Salesforce Classic API
Other Resources
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

inactivateConversation() for LWC for Lightning Experience

Suspends the conversation. This method works only in Lightning console apps.

Arguments

Name Type Description
recordId String The ID of the record for the Messaging session.

Response

Returns a Promise. Success resolves to true. The Promise is rejected if there's an error.