force:workspaceAPI

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

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

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

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

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

closeTab({tabId})

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

focusTab({tabId})

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

getAllTabInfo()

getFocusedTabInfo()

getTabInfo({tabId})

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

getTabURL({tabId})

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

isSubtab({tabId})

• tabId (string): タブの ID。

isConsoleNavigation()

getEnclosingTabId()

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

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

openTab({url, recordId, focus})

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

setTabIcon({tabId, icon, iconAlt})

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

setTabLabel({tabId, label})

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

setTabHighlighted({tabId, highlighted})

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