Newer Version Available
focusPrimaryTabById()
Focuses the browser on a primary tab that is already
open with the specified ID. This
method is only available in API version 22.0 or
later.
Syntax
1sforce.console.focusPrimaryTabById(id:String, (optional)callback:Function)Arguments
Sample Code–Visualforce
1<apex:page standardController="Case">
2
3 <A HREF="#" onClick="testFocusPrimaryTabById();return false">
4 Click here to go to an open primary tab by id</A>
5
6 <apex:includeScript value="/support/console/22.0/integration.js"/>
7 <script type="text/javascript">
8 function testFocusPrimaryTabById() {
9 //Get the value for 'scc-pt-0' from the openPrimaryTab method
10 //This value is for example purposes only
11 var primaryTabId = 'scc-pt-0';
12 sforce.console.focusPrimaryTabById(primaryTabId, focusSuccess);
13 }
14
15 var focusSuccess = function focusSuccess(result) {
16 //Report whether going to the open primary tab was successful
17 if (result.success == true) {
18 alert('Going to the primary tab was successful');
19 } else {
20 alert('Going to the primary tab was not successful');
21 }
22 };
23
24 </script>
25
26</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 field:
| Name | Type | Description |
|---|---|---|
| success | boolean | true if going to the primary tab was successful; false if going to the primary tab wasn't successful. |