refreshSubtabById()

Usage

Refreshes a subtab with the last known URL with a specified ID. This method can't refresh a subtab If the last known URL is an external page or a Visualforce page. This method is only available in API version 22.0 or later.

Syntax

1sforce.console.refreshSubtabById(id:String, active:Boolean, (optional)callback:Function)

Arguments

Name	Type	Description
id	string	ID of the subtab to refresh.
active	boolean	If `true`, the refreshed subtab displays immediately. If `false`, the refreshed subtab displays in the background.
callback	function	JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

1swfobject.registerObject("clippy.codeblock-1", "9");<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testRefreshSubtabById();return false">
4         Click here to refresh a subtab by id</A> 
5
6    <apex:includeScript value="/support/console/22.0/integration.js"/>
7    <script type="text/javascript">
8        function testRefreshSubtabById() {
9            //Set the name of the tab by using the openSubtab method
10            //This value is for example purposes only
11            var subtabId = 'scc-st-0';
12            sforce.console.refreshSubtabById(subtabId, true, refreshSuccess);
13        }
14        
15        var refreshSuccess = function refreshSuccess(result) {
16            //Report whether refreshing the subtab was successful
17            if (result.success == true) {
18                alert('Subtab refreshed successfully');
19            } else {
20                alert('Subtab did not refresh');
21            }
22        };
23        
24  </script>
25
26</apex:page>

This example is set to run by clicking a custom link on a case. For more information, see “Defining Custom Buttons and Links” in the Salesforce online 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 subtab refreshed successfully; `false` if the subtab didn't refresh.

Salesforce Console Integration Toolkit Developer's Guide