Salesforce コンソール開発者ガイド
jLightning Experience の getEnclosingTabId()
囲んでいるタブの ID を返します。
引数
なし。
LWC のサンプルコード
LWC の囲んでいるタブの ID を取得するには、EnclosingTabId ワイヤーアダプターを使用します。
このコンポーネントは、囲んでいるタブの ID を取得してそのタブを閉じます。
1import { LightningElement, wire } from 'lwc';
2import { EnclosingTabId, closeTab } from 'lightning/platformWorkspaceApi';
3
4export class CloseEnclosingTabExample extends LightningElement {
5 @wire(EnclosingTabId) enclosingTabId;
6
7 handleClick() {
8 if (this.enclosingTabId) {
9 return;
10 }
11 closeTab(this.enclosingTabId);
12 }
13}Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、囲んでいるタブの ID が取得されます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspace" />
3 <lightning:button label="Get Enclosing Tab Id" onclick="{! c.getEnclosingTabId }" />
4</aura:component>コントローラーコード:
1({
2 getEnclosingTabId : function(component, event, helper) {
3 var workspaceAPI = component.find("workspace");
4 workspaceAPI.getEnclosingTabId().then(function(tabId) {
5 console.log(tabId);
6 })
7 .catch(function(error) {
8 console.log(error);
9 });
10 }
11})応答
このメソッドは、成功時に囲んでいるタブの tabId (タブ内の場合) または false (タブ内でない場合) に解決される Promise を返します。