Salesforce Console Developer Guide

Salesforce Console Developer Guide
How are the Classic and Lightning APIs Different?
Lightning Experience API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods for Salesforce Classic
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()
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 Live Agent
Methods for Omni-Channel
Other Resources
PDF

Newer Version Available

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

getEnclosingTabId()

Returns the ID of the tab that contains the current Visualforce page, which may be a primary tab or subtab. This method will work if the call is made within a component enclosed within a subtab. This method is only available in API version 20.0 or later.

Syntax

Arguments

Name Type Description
callback function JavaScript method that’s called upon completion of the method.

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 the 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
id string The ID of the current primary tab or subtab.