PageReference の型

Lightning Experience、エクスペリエンスビルダーサイト、または Salesforce モバイルアプリケーションでのナビゲーション用に PageReference オブジェクトを定義します。PageReference 型によって一意の URL が生成され、その型のすべてのページに適用される属性が定義されます。エクスペリエンスビルダーサイトでは、ページ種別によっては、PageReference プロパティの要件が LWR サイトと Aura サイトとで異なる場合があります。

PageReference オブジェクトは、lightning/navigation モジュールの NavigationMixin 関数で使用します。PageReference を使用した移動についての詳細は、「さまざまなページ種別への移動」を参照してください。

Tip

サポートされるページ参照の種別を次に示します。

  • アプリケーション
  • 外部レコードページ
  • 外部レコードリレーションページ
  • ナレッジ記事
  • Lightning コンポーネント
  • ログインページ
  • 管理コンテンツページ (Salesforce CMS)
  • 名前付きページ (エクスペリエンスビルダー)
  • 名前付きページ (標準)
  • ナビゲーション項目ページ
  • オブジェクトページ
  • レコードページ
  • レコードリレーションページ
  • Web ページ

各種別に記載されているように、PageReference オブジェクトはエクスペリエンスビルダーサイトでは制限付きでサポートされます。これらは、Lightning Out ではサポートされていません。

Note

PageReference オブジェクトを使用した移動方法は、Aura イベントを使用して移動する従来の方法に置き換わるものです。たとえば、force:navigateToURL を使用する代わりに、lightning/navigation モジュールを使用して standard__webPage ページ種別で Web ページに移動します。「イベントの移行」を参照してください。

アプリケーション種別 

組織のアプリケーションランチャーから使用できる標準またはカスタムアプリケーション。この種別を使用すると、ユーザを特定のアプリケーションやアプリケーション内のページに移動するカスタムナビゲーションコンポーネントを作成できます。接続アプリケーションはサポートされません。

pageRef を使用してユーザを別のアプリケーションに移動する場合、このアプリケーションは、デフォルトでは同じウィンドウで開きます。新しいタブでリンクを開くには、ナビゲーションサービスに関するドキュメントを参照してください。

Note

型 

1standard__app;

コンテナ 

Lightning Experience

データ型の属性 

プロパティ説明廃止?
appTargetString移動先のアプリケーション。appId または appDeveloperNameappTarget に渡します。
  • appId は、AppDefinition オブジェクトにある DurableId 項目です。
  • appDeveloperName の値を作成するには、アプリケーションの名前空間を API 参照名に連結します。アプリケーションの API 参照名を探すには、[設定] の [アプリケーションマネージャ] に移動して、[API 参照名] 列を調べます。
標準アプリケーションの場合、名前空間は standard__ です。カスタムアプリケーションの場合、名前空間は c__ です。管理パッケージの場合、名前空間は、パッケージに登録された名前空間です。
はい
pageRefPageREference移動先のアプリケーション内の特定の場所を指定します。pageRef とその pageRef 種別の該当する属性を渡します。いいえ

アプリケーションへの移動の例 

1{
2    type: 'standard__app',
3    attributes: {
4        appTarget: 'standard__Sales',
5    }
6}

アプリケーションのレコードへの移動の例 

1{
2    type: 'standard__app',
3    attributes: {
4        appTarget: 'standard__LightningSales',
5        pageRef: {
6            type: 'standard__recordPage',
7            attributes: {
8                recordId: '001xx000003DGg0AAG',
9                objectApiName: 'Account',
10                actionName: 'view'
11            }
12        }
13    }
14}

URL 形式 

1/lightning/app/{appTarget}{...pageRef}

URL 形式の例 

appId を使用して、アプリケーションのホームページに移動

1/lightning/app/06mRM0000008dNrYAI

appId を使用して、アプリケーションのオブジェクトレコードのページに移動

1/lightning/app/06mRM0000008dNrYAI/o/Case/home

appDeveloperName を使用して、アプリケーションのホームページに移動

1/lightning/app/standard__LightningSales

appDeveloperName を使用して、アプリケーションのオブジェクトレコードのページに移動

1/lightning/app/standard__LightningSales/o/Case/home

外部レコードページ種別 

外部レコードを操作するページ。現在、CMS Connect ページをサポートしています。

種別 

1comm__externalRecordPage;

環境 

エクスペリエンスビルダー Aura サイト

データ型の属性 

プロパティ説明必須かどうか
recordIdString外部レコード ID。はい
objectTypeString外部レコード種別。現在サポートしているのは、CMS Connect 用の cms のみです。はい
objectInfoObjectobjectType のレコードを識別するための追加情報。はい

例 

1{
2    type: "comm__externalRecordPage",
3    attributes: {
4        recordId: "26",
5        objectType: "cms",
6        objectInfo: {
7            cmsSourceName: "blog",
8            cmsTypeName: "feed",
9        }
10    },
11    state: {
12        recordName: "coffee-on-the-world-map",
13    }
14}

URL 形式 

1/{baseUrl}/{recordId}/{recordName}

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

組織内の特定のレコードに対する外部リレーションを操作するページ。現在サポートしているのは、Quip 関連リストページのみです。

種別 

1comm__externalRecordRelationshipPage;

環境 

エクスペリエンスビルダー Aura サイト

データ型の属性 

プロパティ説明必須かどうか
recordIdString18 文字のレコード ID。はい
objectTypeString外部レコード種別。現在サポートしているのは、Quip ドキュメント用の quip のみです。はい

例 

1{
2    type: "comm__externalRecordRelationshipPage",
3    attributes: {
4        recordId: "001xx000003DGg0AAG",
5        objectType: "quip",

URL 形式 

1/{baseUrl}/{recordId}

Lightning コンポーネントの種別 

Lightning コンポーネント。アドレス指定可能な Lightning Web コンポーネントを作成するには、lightning:isUrlAddressable インターフェースを実装する Aura コンポーネントにそのコンポーネントを埋め込みます。

型 

1standard__component;

コンテナ 

Lightning Experience、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
componentNameStringnamespace__componentName 形式の Lightning コンポーネント名。はい

例 

1{
2    type: 'standard__component',
3    attributes: {
4        componentName: 'c__MyLightningComponent'
5    },
6    state: {
7        c__counter: '5'
8    }
9}

state オブジェクトには、任意のキーおよび値を渡すことができます。キーには名前空間を含める必要があり、値は文字列にする必要があります。

ナレッジ記事ページ種別 

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

種別 

1standard__knowledgeArticlePage;

コンテナ 

Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
articleTypeStringナレッジ記事レコードの articleType API 参照名。エクスペリエンスビルダーサイトでは、articleType は無視されます。はい
urlNameString参照先 KnowledgeArticleVersion レコードの urlName 項目の値。urlName は記事の URL です。はい

例 

1{
2    type: 'standard__knowledgeArticlePage',
3    attributes: {
4        articleType: 'Briefings',
5        urlName: 'February-2017'
6    }
7}

ログインページ種別 

認証してエクスペリエンスビルダーサイトに入るためのページ。

種別 

1comm__loginPage;

コンテナ 

エクスペリエンスビルダーサイト

属性 

プロパティ説明必須
actionNameString実行するログイン関連のアクション。可能な値は次のとおりです。
  • login
  • logout
はい

例 

1{
2    type: 'comm__loginPage',
3    attributes: {
4        actionName: 'login'
5    }
6}

管理コンテンツページ (Salesforce CMS) 種別 

一意の名前が付けられたエクスペリエンスビルダーサイトの CMS コンテンツページ。

種別 

1standard__managedContentPage;

コンテナ 

エクスペリエンスビルダーサイト

属性 

プロパティ説明必須
contentTypeNameStringSalesforce CMS コンテンツタイプの名前。はい
contentKeyStringCMS を識別する一意のコンテンツキー。はい

例 

1{
2    type: 'standard__managedContentPage',
3    attributes :{
4        'contentTypeName': 'news',
5        'contentKey': 'MCOMALJDRAYFFSFPNBQONYXVFHOA'
6    }
7}

名前付きページ種別 (エクスペリエンスビルダーサイト) 

エクスペリエンスビルダーサイトで使用される一意の名前が付けられた標準ページ。エラーが発生すると、エラービューが読み込まれ、URL は更新されません。

種別 

1comm__namedPage;

コンテナ 

エクスペリエンスビルダーサイト

属性 

プロパティ説明必須
nameStringエクスペリエンスビルダーページの一意の名前。name の値は、サポートされるページの [API 参照名] の値になります。新しいページを作成するときは、[API 参照名] 項目の定義のみを行うことができます。この名前は、一意にする必要があります。[API 参照名] は、ページ作成時に定義しない場合は、自動的に生成されます。home の値は、組織の任意のエクスペリエンスビルダーサイトのランディングページ用に予約されています。エクスペリエンスビルダーサイトでサポートされるページは次の通りです。
  • ホーム
  • 取引先管理
  • カスタマーサポートへの連絡
  • エラー
  • ログイン
  • 私の取引先
  • Top Articles (上位の記事)
  • Topic Catalog (上位のカタログ)
  • カスタムページ
はい

例 

1{
2    type: 'comm__namedPage',
3    attributes: {
4        name: 'Home'
5    }
6}

名前付きページ種別 (標準) 

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

種別 

1standard__namedPage;

コンテナ 

Lightning Experience、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
pageNameStringページの一意の名前。可能な値は次のとおりです。
  • home
  • chatter
  • today
  • dataAssessment
  • filePreview
はい

例 

1{
2    type: 'standard__namedPage',
3    attributes: {
4        pageName: 'home'
5    }
6}

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

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

種別 

1standard__navItemPage;

コンテナ 

Lightning Experience、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
apiNameStringカスタムタブの一意の名前。はい

例 

1{
2    type: 'standard__navItemPage',
3    attributes: {
4        apiName: 'MyCustomTabName'
5    }
6}

例については、「さまざまなページ種別への移動」を参照してください。

オブジェクトページ種別 

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

種別 

1standard__objectPage;

コンテナ 

Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
actionNameString起動するアクション名。有効な値には homelistnew があります。エクスペリエンスビルダーサイトでは、listhome は同一です。はい
objectApiNameString標準またはカスタムオブジェクトの API 参照名。管理パッケージに含まれるカスタムオブジェクトの場合、カスタムオブジェクトに ns__ のプレフィックスを付けます。はい

状態 

プロパティ説明必須かどうか
filterNameStringオブジェクトページの ID または API 参照名。デフォルトは Recent です。サポートされているアクションは list です。いいえ
defaultFieldValuesString渡すデフォルト項目値のキーと値のペアのリスト。このリストは、lightning/pageReferenceUtils モジュールで生成されます。サポートされているアクションは new です。いいえ
nooverrideString標準アクションを使用するには、このプロパティに 1 などの任意の値を割り当てます。上書きアクションを使用するには、このプロパティを一切含めないようにします。次のアクションがサポートされています。homelistnewいいえ

標準オブジェクトの例 

1// Opens the case home page.
2{
3    type: 'standard__objectPage',
4    attributes: {
5        objectApiName: 'Case',
6        actionName: 'home'
7    }
8}

例については、「さまざまなページ種別への移動」を参照してください。

特定のリストビューへの移動例 

1// Navigates to account list with the filter set to Recent.
2{
3    type: 'standard__objectPage',
4    attributes: {
5        objectApiName: 'ns__Widget__c',
6        actionName: 'list'
7    },
8    state: {
9        filterName: 'Recent'
10  }
11}

デフォルト項目値を含むレコード作成ページへの移動 

1// Navigates to a new account page using these default field values:
2//{
3//    Name: 'Salesforce, #1=CRM',
4//    OwnerId: '005XXXXXXXXXXXXXXX',
5//    AccountNumber: 'ACXXXX',
6//    NumberOfEmployees: 35000,
7//    CustomCheckbox__c: true
8//}
9{
10    type: 'standard__objectPage',
11    attributes: {
12        objectApiName: 'Account',
13        actionName: 'new'
14    },
15    state: {
16        defaultFieldValues = 'AccountNumber=ACXXXX,CustomCheckbox__c=true,Name=Salesforce%2C%20%231%3DCRM,NumberOfEmployees=35000,OwnerId=005XXXXXXXXXXXXXXX',
17        nooverride: '1'
18    }
19}

レコードページ種別 

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

種別 

1standard__recordPage;

コンテナ 

Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
actionNameString起動するアクション名。有効な値には cloneeditview があります。エクスペリエンスビルダーサイトでは、cloneedit はサポートされていません。はい
objectApiNameStringレコードのオブジェクトの API 参照名。ルックアップでは省略可能です。
  • 対象はエクスペリエンスビルダー LWR サイトのみ: はい
  • 対象はすべてのコンテナ: いいえ
recordIdString18 文字のレコード ID。はい
  • 状態
プロパティ説明必須かどうか
nooverrideString標準アクションを使用するには、このプロパティに 1 などの任意の値を割り当てます。上書きアクションを使用するには、このプロパティを一切含めないようにします。いいえ

例: レコードページへの移動 

1{
2        type: 'standard__recordPage',
3        attributes: {
4            recordId: '001xx000003DGg0AAG',
5            objectApiName: 'PersonAccount',
6            actionName: 'view'
7        }
8}

例については、「さまざまなページ種別への移動」を参照してください。

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

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

種別 

1standard__recordRelationshipPage;

コンテナ 

Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
actionNameString起動するアクション名。view のみがサポートされています。はい
objectApiNameStringリレーションを定義するオブジェクトの API 参照名。ルックアップでは省略可能です。
  • 対象はエクスペリエンスビルダー LWR サイトのみ: はい
  • 対象はすべてのコンテナ: いいえ
recordIdStringリレーションを定義するレコードの 18 文字のレコード ID。はい
relationshipApiNameStringオブジェクトのリレーション項目の API 参照名。はい

例 

1{
2    type: 'standard__recordRelationshipPage',
3    attributes: {
4        recordId: '500xx000000Ykt4AAC',
5        objectApiName: 'Case',
6        relationshipApiName: 'CaseComments',
7        actionName: 'view'
8    }
9}

例については、「さまざまなページ種別への移動」を参照してください。

Web ページ種別 

外部 URL。

Lightning Web コンポーネントを Aura ベースのエクスペリエンスビルダーサイトで使用する場合は、一部の Salesforce URL にサイト固有の処理があることに注意してください。たとえば、/apex/ URL は /sfdcpage/ に翻訳されます。Visualforce ページは iFrame でサイト内に埋め込まれます。これは force:navigateToURL Aura イベントを使用した場合と同じ動作です。新しいタブで /apex/ を直接開くなど、URL に直接アクセスする場合は window.open を使用してください。

Tip

種別 

1standard__webPage;

コンテナ 

Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション

属性 

プロパティ説明必須
urlString移動先ページの URL。はい

例 

1{
2    type: 'standard__webPage',
3    attributes: {
4        url: 'http://salesforce.com'
5    }
6}

例については、「さまざまなページ種別への移動」を参照してください。

関連トピック

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。