Salesforce Console Developer Guide
jNewer Version Available
getEnclosingTabId() for Lightning Experience
Returns the ID of the enclosing tab. This method isn’t supported for Lightning Web
Components (LWC).
To retrieve the enclosing tab ID with LWC, see EnclosingTabId context wire adapter.
Arguments
None.
Aura Components Sample Code
This component has a button that, when pressed, retrieves the enclosing tab ID.
Component code:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspace" />
3 <lightning:button label="Get Enclosing Tab Id" onclick="{! c.handleGetEnclosingTabId }" />
4</aura:component>Controller code:
1({
2 handleGetEnclosingTabId : function(component, event, helper) {
3 var workspaceAPI = component.find("workspace");
4 workspaceAPI.getEnclosingTabId().then(function(tabId) {
5 console.log(tabId);
6 })
7 .catch(function(error) {
8 console.log(error);
9 });
10 }
11})Response
This method returns a promise that, upon success, resolves
to the tabId of the enclosing tab, if within a tab,
or false if not within a tab.