Lightning Experience の openSubtab()
ワークスペースタブ内のサブタブを開きます。サブタブがすでに開いている場合、サブタブがフォーカスされます。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| parentTabId | string | 新しいサブタブを開くワークスペースタブの ID。 |
| pageReference | object | 開く pageReference を指定します。pageReference は省略可能です。 |
| recordId | ID | 開くレコードを指定します。recordId は省略可能です。 |
| url | string |
新しいワークスペースタブのコンテンツを表す URL。url は省略可能です。 URL は、相対 URL または絶対 URL になります。サードパーティドメインを使用するには、サイトを CSP 信頼済みサイトとして追加します。 |
| focus | boolean | 新しいサブタブにフォーカスするかどうかを指定します。すぐにサブタブを表示するには、focus を true に設定します。バックグラウンドでサブタブを開くには、focus を false に設定します。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、ワークスペースタブ内のサブタブが開きます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspace" />
3 <lightning:button label="Open Tab with Subtab" onclick="{! c.openTabWithSubtab }" />
4 </aura:component>コントローラコード:
1({
2 openTabWithSubtab : function(component, event, helper) {
3 var workspaceAPI = component.find("workspace");
4 workspaceAPI.openTab({
5 url: '/lightning/r/Account/001xx000003DI05AAG/view',
6 focus: true
7 }).then(function(response) {
8 workspaceAPI.openSubtab({
9 parentTabId: response,
10 url: '/lightning/r/Contact/003xx000004Ts30AAC/view',
11 focus: true
12 });
13 })
14 .catch(function(error) {
15 console.log(error);
16 });
17 }
18})応答
このメソッドは、成功時に新しいサブタブの ID に解決される Promise を返します。