getFocusedPrimaryTabId()

Returns the ID of the primary tab on which the browser is focused. This method is only available in API version 25.0 or later.

Syntax

1sforce.console.getFocusedPrimaryTabId((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
3     <A HREF="#" onClick="testGetFocusedPrimaryTabId();return false">
4         Click here to get the focused primary tab ID</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testGetFocusedPrimaryTabId() {
9            sforce.console.getFocusedPrimaryTabId(showTabId);
10        }
11        var showTabId = function showTabId(result) {
12            //Display the tab ID
13            alert('Tab ID: ' + result.id);
14        };
15        
16  </script>
17
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 fields:

Name	Type	Description
`id`	string	The ID of the primary tab on which the browser is focused. If no primary tab is open, the ID is null.
`success`	boolean	`true` if returning the primary tab ID on which the browser is focused was successful; `false` if returning the primary tab ID on which the browser is focused wasn’t successful.