getSubtabIds()
主タブ ID によって指定された主タブ上にあるサブタブのすべての ID を返します。主タブ ID が null の場合、現在の主タブ上にあるサブタブの ID を返します。このメソッドは、カスタムコンソールコンポーネント、または Visualforce ページによって上書きされた詳細ページからのみコールできます。このメソッドは、API バージョン 26.0 以降でのみ使用できます。
構文
1sforce.console.getSubtabIds( (optional) primaryTabId:String, (optional) callback:Function)引数
| 名前 | 型 | 説明 |
|---|---|---|
| primaryTabId | string | サブタブ ID が返される主タブの ID。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
1<apex:page>
2 <A HREF="#" onClick="testGetSubtabIds();return false">
3 Click here to get the subtab IDs</A>
4
5 <apex:includeScript value="/support/console/60.0/integration.js"/>
6 <script type="text/javascript">
7 function testGetSubtabIds() {
8 //Get the subtabs of the primary tab 'scc-pt-0'
9 //This value is for example purposes only
10 var primaryTabId = 'scc-pt-0';
11 sforce.console.getSubtabIds(primaryTabId , showTabId);
12 }
13
14 var showTabId = function showTabId(result) {
15 //Display the subtab IDs
16 alert('Subtab IDs: ' + result.ids);
17 };
18 </script>
19</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジ��クトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| ids | string | 開いているサブタブ ID の配列。 |
| success | boolean | イベントが正常に起動された場合は true、イベントが正常に起動されなかった場合は false。 |