Newer Version Available

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

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().

Syntax

1sforce.console.setCustomConsoleComponentVisible(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="testSetCustomConsoleComponentVisible();return false">
4         Click here to make the custom console component window visible</A> 
5
6    <apex:includeScript value="/support/console/60.0/integration.js"/>
7    <script type="text/javascript">
8        function testSetCustomConsoleComponentVisible() {
9        // Make the custom console component window visible
10            sforce.console.setCustomConsoleComponentVisible(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.