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.
getPrimaryTabIds()
Returns all of the IDs of open primary tabs. This method is only available in
API version 26.0 or later.
Syntax
1sforce.console.getPrimaryTabIds((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>
2 <A HREF="#" onClick="testGetPrimaryTabIds();return false">
3 Click here to get the primary tab IDs</A>
4
5 <apex:includeScript value="/support/console/68.0/integration.js"/>
6 <script type="text/javascript">
7 function testGetPrimaryTabIds() {
8 sforce.console.getPrimaryTabIds(showTabId);
9 }
10
11 var showTabId = function showTabId(result) {
12 //Display the primary tab IDs
13 alert('Primary Tab IDs: ' + result.ids);
14 };
15 </script>
16</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 |
|---|---|---|
| ids | string | An array of open primary tab IDs , in order of appearance. |
| success | boolean | true if returning the IDs of open primary tabs was successful; false if returning the IDs of open primary tabs wasn't successful. |