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.

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

1sforce.console.setCustomConsoleComponentWindowVisible(visible:Boolean, (optional)callback:Function)

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

1<apex:page>
2
3    <A HREF="#" onClick="testSetCustomConsoleComponentWindowVisible();return false">
4         Click here to make the custom console component window visible</A> 
5
6    <apex:includeScript value="/support/console/68.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentWindowVisible() {
9        //Make the custom console component window visible
10            sforce.console.setCustomConsoleComponentWindowVisible(true);
11        }
12    </script>
13</apex:page>

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.

Salesforce Console Developer Guide

setCustomConsoleComponentWindowVisible()

Syntax

Arguments

Sample Code–Visualforce

Response