refreshSubtabByNameAndPrimaryTabId()

Refreshes a subtab with the last known URL with the specified name and primary tab 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.refreshSubtabByNameAndPrimaryTabId(NAME:String, PRIMARY_TAB_ID:String, ACTIVE:Boolean, (optional)CALLBACK:Function, (optional)FULL_REFRESH:Boolean)

Where NAME, PRIMARY_TAB_ID, ACTIVE, CALLBACK, and FULL_REFRESH are variables.

Arguments

Name	Type	Description
`name`	string	Name of the subtab to refresh.
`primaryTabId`	string	ID of the primary tab in which the subtab opened.
`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.
`fullRefresh`	boolean	Enables a full refresh of the entire case feed.

Sample Code–Visualforce

1<apex:page standardController="Case">
2
3     <A HREF="#" onClick="testRefreshSubtabByNameAndPrimaryTabId();return false">
4         Click here to refresh a subtab by name and primary tab ID</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testRefreshSubtabByNameAndPrimaryTabId() {
9            //Get the value for 'mySubtab' and 'scc-pt-0' from the openSubtab method
10            //These values are for example purposes only
11            var subtabName = 'mySubtab';
12            var primaryTabId = 'scc-pt-0';
13            sforce.console.refreshSubtabByNameAndPrimaryTabId(subtabName, primaryTabId, true, refreshSuccess);
14        }
15        
16        var refreshSuccess = function refreshSuccess(result) {
17            //Report whether refreshing the subtab was successful
18            if (result.success == true) {
19                alert('Subtab refreshed successfully');
20            } else {
21                alert('Subtab did not refresh');
22            }
23        };
24        
25  </script>
26
27</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 subtab refreshed successfully; `false` if the subtab didn’t refresh.