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
Using 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
disableUtilityPopOut()
getAllUtilityInfo()
getEnclosingUtilityId()
getUtilityInfo()
isUtilityPoppedOut()
minimizeUtility()
onUtilityClick()
openUtility()
setPanelHeaderIcon()
setPanelHeaderLabel()
setPanelHeight()
setPanelWidth()
setUtilityHighlighted()
setUtilityIcon()
setUtilityLabel()
toggleModalMode()
Methods for Chat
Methods for Omni-Channel
Events
Salesforce Classic API
Other Resources
PDF

Newer Version Available

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

setUtilityLabel() for Lightning Experience

Sets the label of a utility. This text is displayed in the utility bar.

Arguments

Name Type Description
utilityId string The ID of the utility of which to set the label. Optional when called within a utility.
label string The label of the utility displayed in the utility bar.

Sample Code

This component, when added to a single-column Lightning page used in a utility bar, sets the label of the utility to “My Favorite Utility” when the button is pressed.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to true.