Salesforce コンソール開発者ガイド
jLightning Experience の openTab()
新しいワークスペースタブを開きます。タブがすでに開いている場合、タブがフォーカスされます。
引数
Aura コンポーネントと Lightning Web コンポーネント (LWC) のいずれの場合でも、このメソッドの引数は同じです。ただし、icon、iconAlt、および label は、LWC でのみサポートされています。
| 名前 | 型 | 説明 |
|---|---|---|
| pageReference | object | 省略可能。開く一意の URL を生成します。ページ参照には、その型のすべてのページに適用される属性が含まれています。「Aura pageReference の型」および「LWC pageReference の型」を参照してください。 |
| recordId | ID | 省略可能。開くレコードを指定します。 |
| url | URL |
省略可能。新しいワークスペースタブのコンテンツを表�� URL。 URL は、相対 URL または絶対 URL になります。サードパーティドメインを使用するには、サイトを CSP 信頼済みサイトとして追加します。 |
| focus | boolean | 省略可能。新しいタブにフォーカスするかどうかを指定します。すぐにタブを表示するには、focus を true に設定します。バックグラウンドでタブを開くには、focus を false に設定します。 |
| overrideNavRules | boolean | 省略可能。開いているタブに既存のナビゲーションルールが適用されるかどうかを指定します。この引数は、ナビゲーションルールが設定されていないレコードや、レコードを指し示していない URL には影響しません。 |
| icon | string | 省略可能。SLDS アイコンキー。SLDS リファレンスサイトでアイコンキーの完全なリストを確認してください。LWC でのみ使用できます。 |
| iconAlt | string | 省略可能。アイコンの代替テキスト。LWC でのみ使用できます。 |
| label | string | 省略可能。アイコンのテキスト表示ラベル。LWC でのみ使用できます。 |
LWC のサンプルコード
このコンポーネントには、指定されたタブを開き、そのタブにフォーカスを適用する関数があります。
Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、タブが開きます。
コンポーネントコード:
standard__recordPage 型を使用して、pageReference コントローラーコード (pageReference) を渡します。
コントローラーコード (recordId):
コントローラーコード (url):
応答
このメソッドは、成功時に新しいタブの tabId に解決される Promise を返します。