Salesforce Console Developer Guide
jNote: 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.
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
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/68.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. |