setSelectedNavigationTab()

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

Syntax

sforce.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

<apex:page>
    <apex:includeScript value="/support/console/68.0/integration.js"/>
    <script type="text/javascript">
        var callback = function (result) {} 
            if (result.success) {
              alert('Successful');
            } else {
              alert('something is wrong!');
            }
        };
        sforce.console.setSelectedNavigationTab(callback,'nav-tab-4');
    </script>
</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.