Newer Version Available

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

onFocusedPrimaryTab()

Registers a function to call when the focus of the browser changes to a different primary tab. This method is only available in API version 25.0 or later.

Syntax

1sforce.console.onFocusedPrimaryTab(eventHandler:Function)

Arguments

Name Type Description
eventHandler function JavaScript method called when the focus of the browser changes to a different primary tab.

Sample Code–Visualforce

1<apex:page>
2
3    <apex:includeScript value="/support/console/58.0/integration.js"/>
4
5    <script type="text/javascript">
6        var eventHandler = function (result) {
7            alert('Focus changed to a different primary tab. The primary tab ID is:' 
8        + result.id + 'and the object Id is:' + result.objectId);
9        };
10        sforce.console.onFocusedPrimaryTab(eventHandler);
11    </script>
12</apex:page>

Event Handler 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.
objectId string The object ID of the primary tab on which the browser is focused or null if no object exists.