Salesforce Console Developer Guide
jNewer Version Available
getFocusedSubtabId()
Returns the ID of the subtab on which the browser is
focused. For example, a case ID or account ID. This method is only available in API version 25.0 or
later.
Syntax
1sforce.console.getFocusedSubtabId((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>
2 <A HREF="#" onClick="testGetFocusedSubtabId();">
3 Click here to get the ID of the focused subtab</A>
4
5 <apex:includeScript value="/support/console/54.0/integration.js"/>
6 <script type="text/javascript">
7 function testGetFocusedSubtabId() {
8 sforce.console.getFocusedSubtabId(showTabId);
9 }
10 var showTabId = function showTabId(result) {
11 // Display the tab ID
12 alert ('Tab ID: ' + result.id);
13 };
14 </script>
15</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 fields:
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the subtab on which the browser is focused. If no subtab is open, the ID is null. |
| success | boolean | true if returning the ID of the focused subtab was successful; false if returning the ID of the focused subtab wasn't successful. |