refreshSubtabById()

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

refreshSubtabById()

Syntax

Arguments

Sample Code–Visualforce

Response