Newer Version Available

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

getNavigationTabs()

Returns all of the objects in the navigation tab. This method is only available in API version 31.0 or later.

Syntax

1sforce.console.getNavigationTabs((optional)callback:Function)

Arguments

Name Type Description
callback function JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1<apex:page>
2    <apex:includeScript value="/support/console/61.0/integration.js"/>
3    <script type="text/javascript">
4
5        var callback = function (result) { 
6           var id;
7              if (result.success) { 
8                var tempItem = JSON.parse(result.items);
9                for (var i = 0, len = tempItem.length; i < len; i++) {
10           alert('Label:'+tempItem[i].label+'listViewURl:'+tempItem[i].listViewUrl+'navTabid:'
11           +tempItem[i].navigationTabId+'Selected ' +tempItem[i].selected);
12           }
13              } else { 
14                alert('something is wrong!');
15                }
16        };
17        sforce.console.getNavigationTabs(callback);
18    </script>
19</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 fields:
Name Type Description
menuItems object The IDs of objects in the navigation tab.
success boolean true if returning the IDs of objects in the navigation tab was successful, false otherwise.