Salesforce Console Developer Guide

Salesforce Console Developer Guide
How are the Classic and Lightning APIs Different?
Lightning Experience API
Get to Know the Lightning Console
Get to Know the Utility Bar
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Pop-Out Utilities
Using Events in Lightning Console Apps
Using Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods for Lightning Experience
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 Chat
Methods for Omni-Channel
Events for Lightning Experience
Salesforce Classic API
Other Resources
PDF

Newer Version Available

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

getFocusedTabInfo() for Lightning Experience

Returns information about the focused workspace tab or subtab. This method works only in Lightning console apps.

Arguments

None.

Sample Code

This component has a button that, when pressed, closes the currently focused tab.

Component code:

Controller code:

Response

This method returns a promise that, upon success, resolves to a tabInfo object representing the focused 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.