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.
getEnclosingPrimaryTabObjectId()
Returns the object ID of the current
primary tab, which contains a subtab. For example, a case ID or account ID. This method
works within a primary tab or subtab. This method is only available in API version 24.0
or later.
Syntax
1sforce.console.getEnclosingPrimaryTabObjectId((optional)callback:Function)Arguments
| Name | Type | Description |
|---|---|---|
| callback | function | JavaScript method that’s called upon completion of the method. |
Sample Code–Visualforce
1<apex:page standardController="Case">
2 <A HREF="#" onClick="testGetEnclosingPrimaryTabObjectId();">
3 Click here to get enclosing primary tab object ID</A>
4
5 <apex:includeScript value="/support/console/68.0/integration.js"/>
6 <script type="text/javascript">
7 function testGetEnclosingPrimaryTabObjectId() {
8 sforce.console.getEnclosingPrimaryTabObjectId(showObjectId);
9 }
10 var showObjectId = function showObjectId(result) {
11 // Display the object ID
12 alert ('Object ID: ' + result.id);
13 };
14 </script>
15</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 fields:
| Name | Type | Description |
|---|---|---|
| id | string | The ID of the current primary tab that contains this subtab. |
| success | boolean | true if returning the enclosing primary tab was successful; false if returning the enclosing primary tab wasn't successful. |