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
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

isCustomConsoleComponentWindowHidden()

Determines if the application-level custom console component window is hidden. This method is available in API versions 25.0 through 31.0.

If this method is called from a popped out component in a Salesforce console where multi-montior components is turned on, nothing will happen. For more information, see “Turn On Multi-Monitor Components for a Salesforce Console in Salesforce Classic” in the online help. Starting in API version 32.0, this method is no longer available and has been replaced by isCustomConsoleComponentHidden(). For more information, see “isCustomConsoleComponentHidden().”

Note

Syntax

1sforce.console.isCustomConsoleComponentWindowHidden((optional) callback:Function)

Arguments

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

Sample Code–Visualforce

1<apex:page>
2
3     <A HREF="#" onClick="testIsCustomConsoleComponentWindowHidden();return false">
4         Click here to check if the custom console component window is hidden</A> 
5
6    <apex:includeScript value="/support/console/48.0/integration.js"/>
7    <script type="text/javascript">
8        function testIsCustomConsoleComponentWindowHidden() {
9            sforce.console.isCustomConsoleComponentWindowHidden(checkWindowVisibility);
10        }
11        
12        var checkWindowVisibility = function checkWindowVisibility(result) {
13            //Display the window visibility
14            if (result.success) {
15              alert('Is window hidden: ' + result.hidden);
16            } else {
17              alert('Error!');
18            }
19        }
20  </script>
21
22</apex:page>

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
hidden boolean true if the custom console component window is hidden; false if the custom console component window is visible.
success boolean true if returning the custom console component window visibility was successful; false if returning the custom console component window visibility wasn't successful.