focusSubtabByNameAndPrimaryTabId()

Focuses the browser on a subtab that is already open with the specified name and primary tab ID. This method is only available in API version 22.0 or later.

Syntax

1sforce.console.focusSubtabByNameAndPrimaryTabId(name:String, primaryTabId:String,(optional)callback:Function)

Arguments

Name	Type	Description
`name`	string	Name of the subtab to go to.
`primaryTabId`	string	ID of the primary tab in which the subtab opened.
`callback`	function	JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testFocusSubtabByNameAndPrimaryTabId();return false">
4         Click here to go to a subtab by name and primary tab ID</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testFocusSubtabByNameAndPrimaryTabId() {
9            //Get the values for 'mySubtab' and 'scc-pt-0' from the openSubtab method
10            //These values are for example purposes only
11            var subtabName = 'mySubtab';
12            var primaryTabId = 'scc-pt-0';
13            sforce.console.focusSubtabByNameAndPrimaryTabId(subtabName, primaryTabId, focusSuccess);
14        }
15        
16        var focusSuccess = function focusSuccess(result) {
17            //Report whether going to the subtab was successful
18            if (result.success == true) {
19                alert('Going to the subtab was successful');
20            } else {
21                alert('Going to the subtab was not successful');
22            }
23        };
24        
25  </script>
26
27</apex:page>

To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in Salesforce Help.

Note

Response

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:

Name	Type	Description
`success`	boolean	`true` if going to the subtab was successful; `false` if going to the subtab wasn’t successful.