Salesforce Console Integration Toolkit Developer's Guide

Introducing the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
addToBrowserTitleQueue()
blinkCustomConsoleComponentButtonText()
isCustomConsoleComponentPoppedOut()
isCustomConsoleComponentWindowHidden()
isCustomConsoleComponentHidden()
isInCustomConsoleComponent()
onCustomConsoleComponentButtonClicked()
onFocusedPrimaryTab()
removeFromBrowserTitleQueue()
scrollCustomConsoleComponentButtonText()
setCustomConsoleComponentButtonIconUrl()
setCustomConsoleComponentButtonStyle()
setCustomConsoleComponentButtonText()
setCustomConsoleComponentHeight()
setCustomConsoleComponentVisible()
setCustomConsoleComponentWidth()
setCustomConsoleComponentPopoutable()
setCustomConsoleComponentWindowVisible()
setSidebarVisible()
Methods for Push Notifications
Methods for Console Events
Methods for Live Agent
Methods for Omni-Channel
Glossary
PDF

Newer Version Available

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

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.

Syntax

Arguments

Name Type Description
iconUrl string A URL that points to an image that’s used as a button to launch a custom console component.
callback function JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

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 setting the button icon URL was successful; false if setting the button icon URL wasn't successful.