refreshPrimaryTabById()

Refreshes a primary tab specified by ID, including its subtabs. This method can’t refresh subtabs with URLs to external pages or Visualforce pages. This method is only available in API version 22.0 or later.

Syntax

1sforce.console.refreshPrimaryTabById(ID:String, ACTIVATE:Boolean, (optional)CALLBACK:Function, (optional)FULL_REFRESH:Boolean)

Where ID, ACTIVATE, CALLBACK, and FULL_REFRESH are variables.

Arguments

Name	Type	Description
`id`	string	ID of the primary tab to refresh.
`activate`	boolean	If `true`, the refreshed primary tab displays immediately. If `false`, the refreshed primary tab displays in the background.
`callback`	function	JavaScript method that’s called upon completion of the method.
`fullRefresh`	boolean	Enables a full refresh of the entire case feed.

Sample Code–Visualforce

1<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testRefreshPrimaryTabById();return false">
4         Click here to refresh a primary tab by id</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testRefreshPrimaryTabById() {
9            //Get the value for 'scc-pt-0' from the openPrimaryTab method
10            //This value is for example purposes only
11            var primaryTabId = 'scc-pt-0';
12            sforce.console.refreshPrimaryTabById(primaryTabId, true, refreshSuccess);
13        }
14        
15        var refreshSuccess = function refreshSuccess(result) {
16            //Report whether refreshing the primary tab was successful
17            if (result.success == true) {
18                alert('Primary tab refreshed successfully');
19            } else {
20                alert('Primary did not refresh');
21            }
22        };
23        
24  </script>
25
26</apex:page>

To see this example in action, click the custom link on a case. For more information, see Define Custom Buttons and Links in Salesforce Help.

Note

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 the primary tab refreshed successfully; `false` if the primary tab didn’t refresh.