Salesforce Console Developer Guide

What Is the Console Developer Guide?
Why Your UI Matters
Lightning Console JavaScript API for Lightning Experience (Pilot)
Salesforce Console Integration Toolkit for Salesforce Classic
Methods for Salesforce Classic
Methods for Lightning Experience (Pilot)
Methods for Workspace Tabs and Subtabs
closeTab()
focusTab()
getAllTabInfo()
getFocusedTabInfo()
getTabInfo()
getTabURL()
isSubtab()
openSubtab()
openTab()
setTabIcon()
setTabLabel()
Methods for the Utility Bar
Events for Lightning Experience (Pilot)
Other Resources
PDF

Newer Version Available

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

getAllTabInfo() for Lightning Experience

Returns information about all open tabs.

Arguments

Name Type Description
callback function JavaScript method called upon completion of the method. Returns a tabInfo object containing information about all currently open workspace tabs and subtabs.

Sample Code

This component has a button that, gets the info of all open tabs and prints the resulting tabInfo object to the developer console.

Component code:

The relative URL used in this example is a placeholder. To try this example yourself, use a relative URL with a record ID from your org.

Note

Response

This method is asynchronous, and returns an array of tabInfo objects. 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.