Newer Version Available
getSelectedNavigationTab()
Syntax
1sforce.console.getSelectedNavigationTab((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/48.0/integration.js"/>
3 <script type="text/javascript">
4
5 var callback = function (result) {}
6 if (result.success) {
7 alert('the navigation tab id is ' + result.navigationTabId + ' and navigation url is ' + result.listViewUrl);
8 } else {
9 alert('something is wrong!');
10 }
11 };
12 sforce.console.getSelectedNavigationTab(callback);
13 </script>
14</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 |
|---|---|---|
| navigationTabId | string | The object ID of the selected object. |
| listViewUrl | object | The list view URL of the selected object. |
| label | object | The label of the selected object. |
| selected | boolean | true if returning the selected field of the object was successful, false otherwise. |
| success | boolean | true if returning the object IDs was successful, false otherwise. |