lightning:workspaceAPI

このコンポーネントでは、Lightning コンソールアプリケーションのワークスペースタブおよびサブタブをプログラムで制御するメソ��ドにアクセスできます。Lightning コンソールアプリケーションでは、レコードはワークスペースタブとして開き、関連レコードはサブタブとして開きます。

メソッドにアクセスするには、lightning:workspaceAPI コンポーネントのインスタンスを作成し、aura:id 属性を割り当てます。

1<lightning:workspaceAPI aura:id="workspace"/>

次の例では、ボタンをクリックすると、url 属性に指定された相対 URL でレコードを表示する新しいタブが開きます。

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

コンポーネントのボタンにより、次のクライアント側コントローラがコールされます。

1{(
2    openTab : function(component, event, helper) {
3        var workspaceAPI = component.find("workspace");
4        workspaceAPI.openTab({
5            url: '#/sObject/001R0000003HgssIAC/view',
6            focus: true
7        });
8    },
9)}

このコンポーネントは、次のメソッドをサポートします。大部分のメソッドは 1 つの引数 (パラメータの JSON 配列) のみを取ります。これらのメソッドについての詳細は、『コンソール開発者ガイド』を参照してください。

closeTab({tabId})

• tabId (string): 閉じるワークスペースタブまたはサブタブの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

focusTab({tabId})

• tabId (string): フォーカスするワークスペースタブまたはサブタブの ID。

プロミスを返します。成功すると、true に解決します。エラー時にはプロミスは却下されます。

getAllTabInfo()

プロミスを返します。成功すると、tabInfo オブジェクトの配列になります。エラー時にはプロミスは却下されます。

getFocusedTabInfo()

プロミスを返します。成功すると、tabInfo オブジェクトになります。エラー時にはプロミスは却下されます。

getTabInfo({tabId})

• tabId (string): 情報を取得するタブの ID。

プロミスを返します。成功すると、tabInfo オブジェクトになります。エラー時にはプロミスは却下されます。

getTabURL({tabId})

• tabId (string): URL を取得するタブの ID。

プロミスを返します。成功すると、タブ URL になります。エラー時にはプロミスは却下されます。

isSubtab({tabId})

• tabId (string): タブの ID。

プロミスを返します。成功すると、タブがサブタブの場合は true、それ以外は false になります。エラー時にはプロミスは却下されます。

isConsoleNavigation()

プロミスを返します。成功すると、コンソールナビゲーションが存在する場合は true、それ以外は false になります。エラー時にはプロミスは却下されます。

getEnclosingTabId()

プロミスを返します。成功すると、囲んでいるタブ ID になり、タブ内にない場合は false になります。エラー時にはプロミスは却下されます。

openSubtab({parentTabId, url, recordId, focus})

• parentTabId (string): 新しいサブタブを開くワークスペースタブの ID。
• url (string): 省略可能。新しいサブタブのコンテンツを表す URL。URL は、相対 URL または絶対 URL になります。
• recordId (string): 省略可能。新しいサブタブのコンテンツを表すレコード ID。
• focus (boolean): 省略可能。新しいサブタブにフォーカスするかどうかを指定します。

プロミスを返します。成功すると、サブタブの タブ ID になります。エラー時にはプロミスは却下されます。

openTab({url, recordId, focus})

• url (string): 省略可能。新しいタブのコンテンツ���表す URL。URL は、相対 URL または絶対 URL になります。
• recordId (string): 省略可能。新しいタブのコンテンツを表すレコード ID。
• focus (boolean): 省略可能。新しいタブにフォーカスするかどうかを指定します。
• overrideNavRules (boolean): 省略可能。新しいタブを開いたときにナビゲーションルールを上書きするかどうかを指定します。

プロミスを返します。成功すると、ワークスペースのタブ ID になります。エラー時にはプロミスは却下されます。

setTabIcon({tabId, icon, iconAlt})

• tabId (string): アイコンを設定するタブの ID。
• icon (string): SLDS アイコンキー。SLDS リファレンスサイトでアイコンキーの完全なリストを確認してください。
• iconAlt (string): 省略可能。アイコンの代替テキスト。

プロミスを返します。成功すると、変更されたタブの tabInfo オブジェクトになります。エラー時にはプロミスは却下されます。

setTabLabel({tabId, label})

• tabId (string): 表示ラベルを設定するタブの ID。
• label (string): ワークスペースタブまたはサブタブの表示ラベル。

プロミスを返します。成功すると、変更されたタブの tabInfo オブジェクトになります。エラー時にはプロミスは却下されます。

setTabHighlighted({tabId, highlighted})

• tabId (string): 強調表示するタブの ID。
• highlighted (boolean): 新しいタブを強調表示するかどうかを指定します。

プロミスを返します。成功すると、変更されたタブの tabInfo オブジェクトになります。エラー時にはプロミスは却下されます。