Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Change a Visualforce Page by Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods
Methods for Primary Tabs and Subtabs
closeTab()
disableTabClose()
focusPrimaryTabById()
focusPrimaryTabByName()
focusSidebarComponent()
focusSubtabById()
focusSubtabByNameAndPrimaryTabId()
focusSubtabByNameAndPrimaryTabName()
generateConsoleUrl()
getEnclosingPrimaryTabId()
getEnclosingPrimaryTabObjectId()
getEnclosingTabId()
getFocusedPrimaryTabId()
getFocusedPrimaryTabObjectId()
getFocusedSubtabId()
getFocusedSubtabObjectId()
getPageInfo()
getPrimaryTabIds()
getSubtabIds()
getTabLink()
isInConsole()
onEnclosingTabRefresh()
onFocusedPrimaryTab()
onFocusedSubtab()
onTabSave()
openConsoleUrl()
openPrimaryTab()
openSubtab()
openSubtabByPrimaryTabName()
refreshPrimaryTabById()
refreshPrimaryTabByName()
refreshSubtabById()
refreshSubtabByNameAndPrimaryTabId()
refreshSubtabByNameAndPrimaryTabName()
reopenLastClosedTab()
resetSessionTimeOut()
setTabUnsavedChanges()
setTabIcon()
setTabLink()
setTabStyle()
setTabTextStyle()
setTabTitle()
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Chat
Methods for Omni-Channel
Other Resources
PDF

Newer Version Available

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

refreshSubtabByNameAndPrimaryTabName()

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 that’s called upon completion of the method.
fullRefresh boolean Enables a full refresh of the entire case feed.

Sample Code–Visualforce

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.