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
addToBrowserTitleQueue()
closeTab()
disableTabClose()
focusTab()
generateConsoleUrl()
getAllTabInfo()
getEnclosingTabId()
getFocusedTabInfo()
getTabInfo()
getTabURL()
isConsoleNavigation()
isSubtab()
openConsoleUrl()
openSubtab()
openTab()
refreshTab()
removeFromBrowserTitleQueue()
setTabHighlighted()
setTabIcon()
setTabLabel()
Methods for the Utility Bar
Methods for Enhanced Messaging
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

setTabLabel() for Lightning Experience

Sets the label of the specified tab. This method works only in Lightning console apps.

Arguments

Name Type Description
tabId string The ID of the tab for which to set the label.
label string The label of the workspace tab or subtab.

Sample Code

This component has a button that, when pressed, sets the label of the focused tab to “Focused Tab”.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to a tabInfo object representing the modified tab. A tabInfo object is a JSON array of information about a workspace tab, with nested arrays of information on each subtab. This is the structure of a tabInfo object.