Newer Version Available

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

onFocusedSubtab()

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

Syntax

1sforce.console.onFocusedSubtab(eventHandler:Function)

Arguments

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

Sample Code–Visualforce

1<apex:page>
2
3    <apex:includeScript value="/support/console/48.0/integration.js"/>
4
5    <script type="text/javascript">
6        var eventHandler = function (result) {
7            alert('Focus changed to a different subtab. The subtab Id is:' 
8        + result.id + 'and the object Id is:' + result.objectId);
9        };
10        sforce.console.onFocusedSubtab(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 subtab on which the browser is focused.
objectId string The object ID of the subtab on which the browser is focused or null if no object exists.