Salesforce Console Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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()
sendTextMessage()
setAgentInput()
setMessagingComponent()
sendMessagingComponent()
Aura Methods for Enhanced Messaging
Methods for Chat
Methods for Omni-Channel
Events
Salesforce Classic API
Other Resources
PDF

setAgentInput() for LWC for Lightning Experience

Sets the text in the agent's text box. This method works only in Lightning console apps.

Arguments

Name Type Description
recordId String The ID of the record for the Messaging session.
message Object The message object with the message to place in the agent's text box.
setAtCursor Boolean Optional. Indicates whether to insert the message at the current cursor location. If false, the message overwrites any existing text. Default value is false.

message

Name Type Description
text String The message to the agent. For example: { text: "This is a sample message." }

Response

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