Salesforce コンソール開発者ガイド
jLightning Experience の getAllTabInfo()
開いているすべてのタブに関する情報を返します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
なし。
サンプルコード
このコンポーネントにはボタンがあり、押すと、開いているすべてのタブの情報が取得され、結果の 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{ 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}