Salesforce Console Integration Toolkit Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

refreshSubtabByNameAndPrimaryTabName()

Usage

Refreshes a subtab with the last known URL with the specified name and primary tab name. 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

Arguments

Name Type Description
name string Name of the subtab to refresh.
primaryTabName string Name 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 called upon completion of the method.

Sample Code–Visualforce

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.