Lightning Experience の openConsoleUrl()
generateConsoleUrl() で生成された URL を開きます。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| url | string | Salesforce に渡される URL の配列を表すコンソール URL。 |
| focus | boolean | 省略可能。true の場合、ワークスペースタブが開き、すぐに表示されます。false の場合、ワークスペースタブがバックグラウンドで開きます。 |
| labels | string[] | 省略可能。開いているタブの表示ラベルの配列。URL でのタブの表示順序は、配列の順序と一致します。表示ラベルを設定しない場合は、空の文字列を使用します。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、openConsoleUrl() ���ソッドを使用してワークスペースが開きます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspaceAPI" />
3 <lightning:button label="Open Console URL" onclick="{! c.openConsoleUrl }" />
4</aura:component>コントローラコード:
1// Assume URL generated by generateConsoleUrl() API
2// E.g. /lightning/r/Account/001xx000003DGQYAA4/view?ws=%2Flightning%2Fr%2FAccount%2F001xx000003DGQXAA4%2Fview&ctabs=%2Flightning%2Fr%2FAccount%2F001xx000003DGQWAA4%2Fview&activectab=2
3var url = generateConsoleUrl();
4var workspaceAPI = cmp.find("workspaceAPI");
5workspaceAPI.openConsoleURL({
6 "url": url,
7 "focus": true,
8 "labels": ["Workspace Label", "First Subtab Label", "Second Subtab Label"]
9}).then(function(activeTabId) {
10 console.log(activeTabId);
11})
12.catch(function(error) {
13 console.log(error);
14});応答
このメソッドは、成功時に有効なタブの tabId に解決される Promise を返します。