getSubtabIds()
主タブ ID によって指定された主タブ上にあるサブタブのすべての ID を返します。主タブ ID が null の場合、現在の主タブ上にあるサブタブの ID を返します。このメソッドは、カスタムコンソールコンポーネント、または Visualforce ページによって上書きされた詳細ページからのみコールできます。このメソッドは、API バージョン 26.0 以降でのみ使用できます。
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| primaryTabId | string | サブタブ ID が返される主タブの ID。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
応答
このメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| ids | string | 開いているサブタブ ID の配列。 |
| success | boolean | イベントが正常に起動された場合は true、イベントが正常に起動されなかった場合は false。 |