Newer Version Available

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

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

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page standardController="Case">
18    <A HREF="#" onClick="testCloseTab();return false">
19         Click here to close this primary tab</A> 
20
21    <apex:includeScript value="/support/console/20.0/integration.js"/>
22    <script type="text/javascript">
23        function testCloseTab() {
24            //First find the ID of the current primary tab to close it
25            sforce.console.getEnclosingPrimaryTabId(closeSubtab);
26        }
27        
28        var closeSubtab = function closeSubtab(result) {
29            //Now that we have the primary tab ID, we can close it
30            var tabId = result.id;
31            sforce.console.closeTab(tabId);
32        };
33    </script>
34</apex:page>

This example is set to run by clicking a custom link on a case. For more information, see “Defining Custom Buttons and Links” in the Salesforce online 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.