Newer Version Available

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

refreshNavigationTab()

Refreshes the selected navigation tab. This method is only available in API version 31.0 or later.

Syntax

1sforce.console.refreshNavigationTab((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/60.0/integration.js"/>
3    <script type="text/javascript">
4
5        var callback = function (result) {}
6            if(result.success){
7              alert('success');
8            }
9            else{ 
10              alert('Something is wrong.');
11            }
12        };
13        sforce.console.refreshNavigationTab(callback); 
14    </script>
15</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 refreshing the navigation tab was successful, false otherwise.