Salesforce Console Integration Toolkit Developer's Guide
jNewer Version Available
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
Sample Code–Visualforce
1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18
19 <A HREF="#" onClick="testIsInCustomConsoleComponent();return false">
20 Click here to check if the page is in an app-level custom console component</A>
21
22 <apex:includeScript value="/support/console/25.0/integration.js"/>
23 <script type="text/javascript">
24 function testIsInCustomConsoleComponent() {
25 sforce.console.isInCustomConsoleComponent(checkInComponent);
26 }
27
28 var checkInComponent = function checkInComponent(result) {
29 //Check if in component
30 alert('Is in custom console component: ' + result.inCustomConsoleComponent);
31 };
32
33 </script>
34
35</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. |