openConsoleUrl()
generateConsoleUrl() メソッドで作成した URL (Salesforce コンソールのタブ、または関連タブのグループへの URL) を開きます。このメソッドは、API バージョン 28.0 以降でのみ使用できます。
構文
引数
| 名前 | 型 | 説明 |
|---|---|---|
| id | string | 上書きするコンソールタブの ID。ID が既存の主タブに対応している場合、コンソールではタブの重複が無効であるため、指定された URL に既存の主タブがリダイレクトされます。新しい主タブを作成するには、null を使用します。 |
| consoleUrl | string | Salesforce に渡される URL の配列を表すコンソール URL。 |
| active | boolean | true の場合、開いている主タブがすぐに表示されます。false の場合、開いている主タブが背景で開き、フォーカスは現在のタブに残ります。 |
| tabLabels | string | 開いている主タブまたはサブタブの表示ラベルの配列 (省略可能)。コンソール URL でのタブの表示順序は、配列に表示される表示ラベルの順序と一致します。タブの表示ラベルを表示しない場合は、空の文字列 ('') を使用します。 |
| tabNames | string | 開いている主タブまたはサブタブの名前の配列 (省略可能)。コンソール URL でのタブの表示順序は、配列に表示される名前の順序と一致します。タブの名前を表示しない場合は、空の文字列 ('') を使用します。 |
| callback | function | メソッドの完了時にコールされる JavaScript メソッド。 |
サンプルコード – Visualforce
応答
���のメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。応答オブジェクトには次の項目が含まれます。
| 名前 | 型 | 説明 |
|---|---|---|
| success | boolean | コンソール URL が正常に開いた場合は true、そうでない場合は false。 |