Lightning Experience の generateConsoleUrl()
ワークスペースタブおよびそのサブタブの URL を生成します。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。Lightning Web コンポーネントではサポートされていません。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| pageReferences | pageReference[] | ページの参照の配列。最初のページの参照はワークスペースタブです。次のページの参照はサブタブです。最後のページの参照はフォーカスされたサブタブです。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、generateConsoleUrl() メソッドを使用して、指定されたページの参照の URL を作成します。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspaceAPI" />
3 <lightning:button label="Get Console URL" onclick="{! c.generateConsoleUrl }" />
4</aura:component>コントローラコード:
1({
2 generateConsoleUrl : function(component, event, helper) {
3 var workspaceAPI = cmp.find("workspaceAPI");
4 workspaceAPI.generateConsoleURL({
5 "pageReferences": [
6 {
7 "type": "standard__recordPage",
8 "attributes": {
9 "objectApiName": "Account",
10 "actionName": "view",
11 "recordId": "001xx000003DGQXAA4"
12 },
13 "state": {}
14 },
15 {
16 "type": "standard__recordPage",
17 "attributes": {
18 "objectApiName": "Account",
19 "actionName": "view",
20 "recordId": "001xx000003DGQWAA4"
21 },
22 "state": {}
23 },
24 {
25 "type": "standard__recordPage",
26 "attributes": {
27 "objectApiName": "Account",
28 "actionName": "view",
29 "recordId": "001xx000003DGQYAA4"
30 },
31 "state": {}
32 }
33 ]
34 }).then(function(url) {
35 console.log(url);
36 })
37 .catch(function(error) {
38 console.log(error);
39 });
40 }
41})応答
このメソッドは、成功時に生成された URL で解決される Promise を返します。
| 名前 | 型 | 説明 |
|---|---|---|
| url | string | Salesforce に渡される URL の配列を表すコンソール URL。 |