getEnclosingPrimaryTabId()

Returns the ID of the current primary tab. This method works within a primary tab or subtab, not within the navigation tab or custom console components. This method is only available in API version 20.0 or later.

Syntax

1sforce.console.getEnclosingPrimaryTabId((optional)callback:function)

Arguments

Name	Type	Description
callback	function	JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1<apex:page standardController="Case">
2    <A HREF="#" onClick="testCloseTab();return false">
3         Click here to close this primary tab</A> 
4
5    <apex:includeScript value="/support/console/51.0/integration.js"/>
6    <script type="text/javascript">
7        function testCloseTab() {
8            //First find the ID of the current primary tab to close it
9            sforce.console.getEnclosingPrimaryTabId(closeSubtab);
10        }
11        
12        var closeSubtab = function closeSubtab(result) {
13            //Now that we have the primary tab ID, we can close it
14            var tabId = result.id;
15            sforce.console.closeTab(tabId);
16        };
17    </script>
18</apex:page>

To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in the Salesforce help.

Note

Response

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:

Name	Type	Description
id	string	The ID of the current primary tab that contains this tab.

Salesforce Console Developer Guide

getEnclosingPrimaryTabId()

Syntax

Arguments

Sample Code–Visualforce

Response