この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Lightning Experience の getTabInfo()

指定されたタブに関する情報を返します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。

引数

名前	型	説明
tabId	string	情報を取得するタブの ID。

サンプルコード

このコンポーネントにはボタンがあり、押すと、タブが開き、getTabInfo() メソッドを使用して新しいタブの tabInfo が開発者コンソールに出力されます。

コンポーネントコード:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2    <lightning:workspaceAPI aura:id="workspace" />
3    <lightning:button label="Get Opened Tab Info" onclick="{! c.getOpenedTabInfo }" />
4 </aura:component>

コントローラコード:

1({
2    getOpenedTabInfo : 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.getTabInfo({
9                tabId: response
10            }).then(function(response) {
11                console.log(response);
12            });
13        })
14        .catch(function(error) {
15            console.log(error);
16        });
17    }
18})

この例で使用される相対 URL はプレースホルダです。この例を自分で試すには、組織のレコード ID が含まれる相対 URL を使用してください。

メモ

応答

このメソッドは、成功時に指定されたタブを表す tabInfo オブジェクトに解決される Promise を返します。tabInfo オブジェクトは、ワークスペースタブに関する情報の JSON 配列で、各サブタブに関する情報の配列がネストされています。tabInfo オブジェクトの構造を次に示します。

1{ tabId: string,
2     active: boolean,
3     pinned: boolean,
4     closeable: boolean,
5     highlighted: boolean,
6     title: string,
7     icon: string (SLDS iconKey),
8     iconAlt: string,
9     recordId: string,
10     url: string (URL),
11     pageReference: object,
12     subtabs: [
13         {
14             tabId: string,
15             active: boolean,
16             pinned: boolean,
17             closeable: boolean,
18             highlighted: boolean,
19             title: string,
20             icon: string (SLDS iconKey),
21             iconAlt: string,
22             recordId: string,
23             url: string (URL),
24             pageReference: object,
25             isSubtab: boolean,
26             parentTabId: string,
27             customTitle: string,
28             customIcon: string (URL),
29             customIconAlt: string
30          },
31          { ... }
32     ],
33     isSubtab: boolean,
34     parentTabId: string,
35     customTitle: string,
36     customIcon: string (URL),
37     customIconAlt: string
38}

Salesforce コンソール開発者ガイド

Lightning Experience の getTabInfo()

引数

サンプルコード

応答