Salesforce コンソール開発者ガイド
jLightning Experience の getTabInfo()
指定されたタブに関する情報を返します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
Aura コンポーネントと Lightning Web コンポーネント (LWC) のいずれの場合でも、このメソッドの引数は同じです。
| 名前 | 型 | 説明 |
|---|---|---|
| tabId | string | 情報を取得するタブの ID。 |
LWC のサンプルコード
このコンポーネントには、タブ情報を返す関数があります。
1import { EnclosingTabId, getTabInfo } from 'lightning/platformWorkspaceApi';
2export class ConsoleNavExample extends LightningElement {
3 @wire(EnclosingTabId) enclosingTabId;
4 handleClick() {
5 if (this.enclosingTabId) {
6 getTabInfo(this.enclosingTabId).then((tabInfo) => {
7 // do something with it
8 }).catch((error) => {
9 console.log(error);
10 });
11 }
12 }
13}Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、タブが開き、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})応答
このメソッドは、成功時に指定されたタブを表す 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}