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

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page standardController="Case">
18    <A HREF="#" onClick="testGetEnclosingPrimaryTabObjectId();">
19           Click here to get enclosing primary tab object ID</A> 
20
21    <apex:includeScript value="/support/console/24.0/integration.js"/>
22    <script type="text/javascript">
23        function testGetEnclosingPrimaryTabObjectId() {
24            sforce.console.getEnclosingPrimaryTabObjectId(showObjectId);
25        }
26            var showObjectId = function showObjectId(result) {
27                // Display the object ID
28            alert ('Object ID: ' + result.id);
29        };
30    </script>
31</apex:page>

This example is set to run by clicking a custom link on a case. For more information, see “Defining Custom Buttons and Links” in the Salesforce online help.

Note

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.

Salesforce Console Integration Toolkit Developer's Guide

getEnclosingPrimaryTabObjectId()

Syntax

Arguments

Sample Code–Visualforce

Response