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

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

For more information, see “Custom Console Components Overview” in the Salesforce Help.

You can use the following methods for components that display content across all pages and tabs (referred to as the application level of a console):
Method Description
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.
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().
isCustomConsoleComponentPoppedOut() Determines if a custom console component is popped out from a browser. To use this method, multi-monitor components must be turned on. For more information, see “Set Multi-Monitor Components for a Salesforce Console” in the online help. 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.
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.
onFocusedPrimaryTab() Registers a function to call when the focus of the browser changes to a different primary tab. 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.
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.
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.
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.
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. For more information, see “Set Multi-Monitor Components for a Salesforce Console” in the online help. This method is only available in API version 30.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.
setCustomConsoleComponentWindowVisible() Sets the window visibility of an application-level custom console component that’s on a page. This method is available only in API version 31.0 or earlier.
setSidebarVisible() Shows or hides a console sidebar based on tabId and region. This method is available in API version 33.0 or later.