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.
Where ID, ACTIVATE, CALLBACK, and FULL_REFRESH are variables.
| 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. |
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.
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. |