isInCustomConsoleComponent()

Determines if the page is in an application-level custom console component. This method is only available in API version 25.0 or later.

Syntax

1sforce.console.isInCustomConsoleComponent((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="testIsInCustomConsoleComponent();return false">
4         Click here to check if the page is in an app-level custom console component</A> 
5
6    <apex:includeScript value="/support/console/63.0/integration.js"/>
7    <script type="text/javascript">
8        function testIsInCustomConsoleComponent() {
9            sforce.console.isInCustomConsoleComponent(checkInComponent);
10        }
11        
12        var checkInComponent = function checkInComponent(result) {
13            //Check if in component
14            alert('Is in custom console component: ' + result.inCustomConsoleComponent);
15        };
16        
17  </script>
18
19</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
inCustomConsoleComponent	boolean	`true` if the page is in a custom console component; `false` if the page isn’t in a custom console component.
success	boolean	`true` if returning the page status was successful; `false` if returning the page status wasn't successful.

Salesforce Console Developer Guide

isInCustomConsoleComponent()

Syntax

Arguments

Sample Code–Visualforce

Response