Salesforce Console Integration Toolkit Developer's 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
1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18 <A HREF="#" onClick="testGetFocusedSubtabId();">
19 Click here to get the ID of the focused subtab</A>
20
21 <apex:includeScript value="/support/console/25.0/integration.js"/>
22 <script type="text/javascript">
23 function testGetFocusedSubtabId() {
24 sforce.console.getFocusedSubtabId(showTabId);
25 }
26 var showTabId = function showTabId(result) {
27 // Display the tab ID
28 alert ('Tab ID: ' + result.id);
29 };
30 </script>
31</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. |