Salesforce Console Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
getEnclosingTabId()
Returns the ID of the tab that contains the current
Visualforce page, which may be a
primary tab or subtab. This method will work if the call is made within a component
enclosed within a subtab. This method is only available in API version 20.0 or later.
Syntax
1sforce.console.getEnclosingTabId()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 tab</A>
4
5 <apex:includeScript value="/support/console/68.0/integration.js"/>
6 <script type="text/javascript">
7 function testCloseTab() {
8 //First find the ID of the current tab to close it
9 sforce.console.getEnclosingTabId(closeSubtab);
10 }
11
12 var closeSubtab = function closeSubtab(result) {
13 //Now that we have the tab ID, we can close it
14 var tabId = result.id;
15 sforce.console.closeTab(tabId);
16 };
17 </script>
18</apex:page>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 or subtab. |