Salesforce Console Developer Guide
jWinter '27 preview (API version 68.0)
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
When to Use the Salesforce Console Integration Toolkit
Change a Visualforce Page by Using the Salesforce Console Integration Toolkit
addToBrowserTitleQueue()
blinkCustomConsoleComponentButtonText()
isCustomConsoleComponentPoppedOut()
isCustomConsoleComponentWindowHidden()
isCustomConsoleComponentHidden()
isInCustomConsoleComponent()
onCustomConsoleComponentButtonClicked()
removeFromBrowserTitleQueue()
runSelectedMacro()
scrollCustomConsoleComponentButtonText()
selectMacro()
setCustomConsoleComponentButtonIconUrl()
setCustomConsoleComponentButtonStyle()
setCustomConsoleComponentButtonText()
setCustomConsoleComponentHeight()
setCustomConsoleComponentVisible()
setCustomConsoleComponentWidth()
setCustomConsoleComponentPopoutable()
setCustomConsoleComponentWindowVisible()
setSidebarVisible()
Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Methods for Application-Level Custom Console Components
Custom console components let you customize, extend, or integrate the footer, sidebars, highlights panels, and interaction logs of a Salesforce console using Visualforce, canvas apps, lookup fields, or related lists. Administrators can add components to either:
- Page layouts to display content on specific pages
- Salesforce console apps to display content across all pages and tabs
-
addToBrowserTitleQueue()
Adds a browser tab title to a list of titles, which rotates every three seconds. This method is only available in API version 28.0 or later. -
blinkCustomConsoleComponentButtonText()
Blinks a button’s text on an application-level custom console component that’s on a page. This method is only available in API version 25.0 or later. This method isn’t supported in Lightning Console. -
isCustomConsoleComponentPoppedOut()
Determines if a custom console component is popped out from a browser. To use this method, multi-monitor components must be turned on. This method is only available in API version 30.0 or later. -
isCustomConsoleComponentWindowHidden()
Determines if the application-level custom console component window is hidden. This method is available in API versions 25.0 through 31.0. -
isCustomConsoleComponentHidden()
Determines if the application-level custom console component window is hidden. This method is available in API version 32.0 and later. In API version 31.0 and earlier, this method was called isCustomConsoleComponentWindowHidden(). -
isInCustomConsoleComponent()
Determines if the page is in an application-level custom console component. This method is only available in API version 25.0 or later. -
onCustomConsoleComponentButtonClicked()
Registers a function to call when a button is clicked on an application-level custom console component. This method is only available in API version 25.0 or later. -
removeFromBrowserTitleQueue()
Removes a browser tab title from the list of titles, which rotates every three seconds. This method is only available in API version 28.0 or later. -
runSelectedMacro()
Executes the selected macro in the macro widget. This method is only available in API version 36.0 or later. This method isn’t supported in Lightning Console. -
scrollCustomConsoleComponentButtonText()
Scrolls a button’s text on an application-level custom console component that’s on a page. This method is only available in API version 25.0 or later. This method isn’t supported in Lightning Console. -
selectMacro()
Selects and displays a specific macro in the macro widget. This method is only available in API version 36.0 or later. This method isn’t supported in Lightning Console. -
setCustomConsoleComponentButtonIconUrl()
Sets the button icon URL of an application-level custom console component that’s on a page. This method is only available in API version 25.0 or later. -
setCustomConsoleComponentButtonStyle()
Sets the style of a button used to launch an application-level custom console component that’s on a page. This method is only available in API version 25.0 or later. This method isn’t supported in Lightning Console. -
setCustomConsoleComponentButtonText()
Sets the text on a button used to launch an application-level custom console component that’s on a page. This method is only available in API version 25.0 or later. -
setCustomConsoleComponentHeight()
Sets the window height of an application-level custom console component that’s on a page. This method is available in API version 32.0 or later. -
setCustomConsoleComponentVisible()
Sets the window visibility of an application-level custom console component that’s on a page. This method is available in API version 32.0 and later. In API version 31.0 and earlier, this method was called setCustomConsoleComponentWindowVisible(). -
setCustomConsoleComponentWidth()
Sets the window width of an application-level custom console component that’s on a page. This method is available in API version 32.0 or later. -
setCustomConsoleComponentPopoutable()
Sets a custom console component to be popped out or popped into a browser. To use this method, multi-monitor components must be turned on. This method is only available in API version 30.0 or later. -
setCustomConsoleComponentWindowVisible()
Sets the window visibility of an application-level custom console component that’s on a page. This method is available in API versions 25.0 through 31.0. This method isn’t supported in Lightning Console. -
setSidebarVisible()
Shows or hides a console sidebar based on tabId and region. This method is available in API version 33.0 or later. This method isn’t supported in Lightning Console.