この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

pageReference の型

Lightning Experience、Lightning コミュニティ、または Salesforce モバイルアプリケーションでのナビゲーション用に PageReference オブジェクトを定義します。pageReference 型によって一意の URL が生成され、その型のすべてのページに適用される属性が定義されます。
次のデータ型がサポートされています。
  • Lightning コンポーネント (lightning:isUrlAddressable を実装する必要があります)
  • ナレッジ記事
  • ログインページ
  • 名前付きページ
  • ナビゲーション項目ページ
  • オブジェクトページ
  • レコードページ
  • レコードリレーションページ
  • Web ページ

Lightning コミュニティでは、各タイプに注釈があるように、PageReference オブジェクトのサポートは制限付きです。

メモ

Lightning コンポーネントの種類

lightning:isUrlAddressable インターフェースを実装する Lightning コンポーネント。URL で直接コンポーネントのナビゲーションができるようにします。

1standard__component
環境
Lightning Experience、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
componentName String namespace__componentName 形式の Lightning コンポーネント名。 Y
1{    
2    "type": "standard__component",
3    "attributes": {
4        "componentName": "c__MyLightningComponent"    
5    },    
6    "state": {
7        "myAttr": "attrValue"    
8    }
9}
URL 形式
1/cmp/{componentName}?myAttr=attrValue

ログインページの種別

コミュニティの認証。

1comm__loginPage
環境
Lightning コミュニティ
データ型の属性
プロパティ 説明 必須
actionName String 実行するログイン関連のアクション。値は次のとおりです。
  • login
  • logout
はい
1{
2    type: “comm__loginPage”,
3    attributes: {
4        actionName: “login
5    }
6}

ナレッジ記事ページの種別

ナレッジ記事レコードを操作するページ。

1standard__knowledgeArticlePage
環境
Lightning Experience、Lightning コミュニティ、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
articleType String ナレッジ記事レコードの ArticleType API 参照名。

コミュニティでは、articleType は無視されます。

Y
urlName String 参照先 KnowledgeArticleVersion レコードの urlName 項目の値。urlName は記事の URL です。 Y
1{    
2    "type": "standard__knowledgeArticlePage",
3    "attributes": {
4        "articleType": "Briefings",
5        "urlName": "February-2017"
6    }
7}
URL 形式
1/articles/{articleType}/{urlName}

名前付きページの種別

一意の名前が付けられた標準ページ。エラーが発生すると、エラービューが読み込まれ、URL は更新されません。.

種別
1standard__namedPage
1comm__namedPage
環境
Lightning Experience、Lightning コミュニティ、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
pageName String ページの一意の名前。
Lightning Experience と Salesforce モバイルアプリケーションで可能な値は次の通りです。
  • home
  • chatter
  • today
  • dataAssessment
  • filePreview

コミュニティでは、pageName の値はサポートされるページの URL 値となります。たとえば、[Account Management (アカウント管理)] ページのデフォルト URL は /account-management であるため、pageName の値は account-management となります。

home の値は、組織の任意のコミュニティのランディングページ用に予約されています。

ただし、コミュニティのページは Lightning Experience のページとは異なるため、管理を容易にして明確さを向上させるため、専用の名前空間に移動しています。コミュニティでは、standard__namedPage は推奨されません。代わりに comm__namedPage を使用してください。

コミュニティでサポートされるページは次の通りです。
  • ホーム
  • 取引先管理
  • カスタマーサポートへの連絡
  • エラー
  • ログイン
  • 上位の記事
  • トピックカタログ
  • カスタムページ
Y
Lightning Experience の例
1{    
2    "type": "standard__namedPage",
3    "attributes": {
4        "pageName": "home"    
5    }
6}
Lightning コミュニティの例
1{
2    type: "comm__namedPage",
3    attributes: {
4        pageName: "home"
5    }
6}
URL 形式
1/page/{pageName}

ナビゲーション項目ページの種別

カスタムタブに対応付けられたコンテンツを表示するページ。Visualforce タブ、Web タブ、Lightning ページ、Lightning コンポーネントタブがサポートされています。

種別
1standard__navItemPage
環境
Lightning Experience、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
apiName String カスタムタブの一意の名前。 Y
1{    
2    "type": "standard__navItemPage",
3    "attributes": {
4        "apiName": "MyCustomTabName"    
5    }
6}
URL 形式
1/n/{devName}

オブジェクトページの種別

組織内の標準またはカスタムオブジェクトを操作するページ。そのオブジェクトの標準アクションがサポートされます。

force:navigateToObjectHome および force:navigateToList イベントが standard__objectPage 種別に置き換わります。

メモ

1standard__objectPage
環境
Lightning Experience、Lightning コミュニティ、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
actionName String 起動するアクション名。有効な値は、homelistnew です。

コミュニティでは、listhome は同じです。

Y
objectApiName String 標準またはカスタムオブジェクトの API 参照名。管理パッケージに含まれるカスタムオブジェクトの場合、カスタムオブジェクトに ns__ のプレフィックスを付けます。 Y
標準オブジェクトの例
1{    
2    "type": "standard__objectPage",
3    "attributes": {
4        "objectApiName": "Case",
5        "actionName": "home"
6    }
7}
1{
2    type: "standard__objectPage",
3    attributes: {
4        objectApiName: "Account",
5        actionName: "list"
6    },
7    state: {
8        filterName: "RecentlyViewedAccounts"
9    }
10}
特定のリストビューへの移動例
1{    
2    "type": "standard__objectPage",
3    "attributes": {
4        "objectApiName": "ns__Widget__c",
5        "actionName": "list"
6    },
7    "state": {
8        "filterName": "RecentlyViewedAccounts"
9  }
10}
URL 形式
1/o/{objectApiName}/{actionName}
2/o/{objectApiName}/{actionName}?filterName=Recent

レコードページの種別

組織内のレコードを操作するページ。そのレコードの標準アクションがサポートされます。

force:navigateToSObject イベントが standard__recordPage 種別に置き換わります。

メモ

1standard__recordPage
環境
Lightning Experience、Lightning コミュニティ、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
actionName String 起動するアクション名。有効な値は、cloneeditview です。

コミュニティでは、clone または edit の値はサポートしません。

Y
objectApiName String レコードのオブジェクトの API 参照名。ルックアップでは省略可能です。
recordId String 18 文字のレコード ID。 Y
1{    
2       "type": "standard__recordPage",
3       "attributes": {
4           "recordId": "001xx000003DGg0AAG",
5           "objectApiName": "PersonAccount",
6           "actionName": "view"
7       }
8}
URL 形式
1/r/{objectApiName}/{recordId}/{actionName}
2/r/{recordId}/{actionName}

レコードリレーションページの種別

組織内の特定のレコードに対するリレーションを操作するページ。関連リストのみがサポートされています。

force:navigateToRelatedList イベントが standard__recordRelationshipPage 種別に置き換わります。

メモ

1standard__recordRelationshipPage
環境
Lightning Experience、Salesforce モバイルアプリケーション
データ型の属性
プロパティ 説明 必須かどうか
actionName String 起動するアクション名。view のみがサポートされています。 Y
objectApiName String リレーションを定義するオブジェクトの API 参照名。ルックアップでは省略可能です。
recordId String リレーションを定義するレコードの 18 文字のレコード ID。 Y
relationshipApiName String オブジェクトのリレーション項目の API 参照名。
1{    
2    "type": "standard__recordRelationshipPage",
3    "attributes": {
4        "recordId": "500xx000000Ykt4AAC",
5        "objectApiName": "Case",
6        "relationshipApiName": "CaseComments",
7        "actionName": "view"
8    }
9}
URL 形式
1/r/{objectApiName}/{recordId}/related/{relationshipApiName}/{actionName}
2/r/{recordId}/related/{relationshipApiName}/{actionName}

Web ページ

外部 URL。

standard__webPage 型が force:navigateToURL イベントに置き換わります。

メモ

1standard__webPage
環境
Lightning Experience、Salesforce モバイルアプリケーション
属性
プロパティ 説明 必須
url String 移動先ページの URL。 はい
1{    
2    "type": "standard__webPage",
3    "attributes": {
4        "url": "http://salesforce.com"
5    }
6},
7{
8    replace: true
9}
ブラウザのセッション履歴で現在のページをこの URL に置き換えるには、replacetrue に設定します。現在のページはセッション履歴には保存されないため、後で現在のページに戻ることはできなくなります。外部リンクでは、replace 属性は無視されます。
URL 形式
Web ページは新しいタブでそのまま開くため、URL 形式はありません。