Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

setSelectedNavigationTab()

Sets the navigation tab with a specific ID or URL. This method is only available in API version 31.0 or later.

Syntax

1sforce.console.setSelectedNavigationTab((optional)callback, navigatorTabId:(optional)string, url:(optional)string)

Arguments

Name	Type	Description
callback	function	JavaScript method that’s called upon completion of the method.
navigatorTabId	string	The ID of the navigation tab to be selected.
url	string	The URL of the navigation tab to be selected.

Sample Code–Visualforce

1<apex:page>
2    <apex:includeScript value="/support/console/68.0/integration.js"/>
3    <script type="text/javascript">
4        var callback = function (result) {} 
5            if (result.success) {
6              alert('Successful');
7            } else {
8              alert('something is wrong!');
9            }
10        };
11        sforce.console.setSelectedNavigationTab(callback,'nav-tab-4');
12    </script>
13</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 setting the navigation tab with a specific ID or URL was successful, `false` otherwise.

Salesforce Console Developer Guide

setSelectedNavigationTab()

Syntax

Arguments

Sample Code–Visualforce

Response