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
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
addToBrowserTitleQueue()
blinkCustomConsoleComponentButtonText()
isCustomConsoleComponentPoppedOut()
isCustomConsoleComponentWindowHidden()
isCustomConsoleComponentHidden()
isInCustomConsoleComponent()
onCustomConsoleComponentButtonClicked()
removeFromBrowserTitleQueue()
runSelectedMacro()
scrollCustomConsoleComponentButtonText()
selectMacro()
setCustomConsoleComponentButtonIconUrl()
setCustomConsoleComponentButtonStyle()
setCustomConsoleComponentButtonText()
setCustomConsoleComponentHeight()
setCustomConsoleComponentVisible()
setCustomConsoleComponentWidth()
setCustomConsoleComponentPopoutable()
setCustomConsoleComponentWindowVisible()
setSidebarVisible()
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

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.

If this method is called from a popped out component in a Salesforce console where multi-montior components is turned on, nothing will happen. Starting in API version 32.0, this method is no longer available and has been replaced by setCustomConsoleComponentVisible(). For more information, see setCustomConsoleComponentVisible().

Note

Syntax

Arguments

Name Type Description
visible boolean true to make the custom console component window visible, false to hide the custom console component window.
callback function JavaScript method that’s called upon completion of the method.

Sample Code–Visualforce

Response

Name Type Description
success boolean true if setting the button window visibility was successful; false if setting the button window visibility wasn't successful.