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
1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17<apex:page>
18 <A HREF="#" onClick="testGetSubtabIds();return false">
19 Click here to get the subtab IDs</A>
20
21 <apex:includeScript value="/support/console/26.0/integration.js"/>
22 <script type="text/javascript">
23 function testGetSubtabIds() {
24 //Get the subtabs of the primary tab 'scc-pt-0'
25 //This value is for example purposes only
26 var primaryTabId = 'scc-pt-0';
27 sforce.console.getSubtabIds(primaryTabId , showTabId);
28 }
29
30 var showTabId = function showTabId(result) {
31 //Display the subtab IDs
32 alert('Subtab IDs: ' + result.ids);
33 };
34 </script>
35</apex:page>応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| ids | string | 開いているサブタブ ID の配列。 |
| success | boolean | イベントが正常に起動された場合は true、イベントが正常に起動されなかった場合は false。 |