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

Lightning Experience の getAllTabInfo()

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

引数

なし。

LWC のサンプルコード

このコンポーネントには、タブ情報を返す関数があります。

1import { LightningElement, wire } from 'lwc';
2import { IsConsoleNavigation, getAllTabInfo } from 'lightning/platformWorkspaceApi';
3
4export class ConsoleNavExample extends LightningElement {
5    @wire(IsConsoleNavigation) isConsoleNavigation;
6
7    handleClick() {
8        if (this.isConsoleNavigation) {
9            getAllTabInfo().then((tabInfo) => {
10                // do something with it
11            }).catch(function(error) {
12                console.log(error);
13            }); 
14        }
15    }
16}

Aura コンポーネントのサンプルコード

このコンポーネントにはボタンがあり、押すと、開いているすべてのタブの情報が取得され、結果の tabInfo オブジェクトが出力されます。

コンポーネントコード:

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

コントローラーコード:

1({
2    getAllTabInfo : function(component, event, helper) {
3        var workspaceAPI = component.find("workspace");
4        workspaceAPI.getAllTabInfo().then(function(response) {
5            console.log(response);
6       })
7        .catch(function(error) {
8            console.log(error);
9        });
10    }
11})

応答

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

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

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

Lightning Experience の getAllTabInfo()

引数

LWC のサンプルコード

Aura コンポーネントのサンプルコード

応答