PageReference の型

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

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

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

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

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

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

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

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

Lightning Experience

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

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

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

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

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

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

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

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

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

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

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

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

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

プロパティ	型	説明	必須
`componentName`	String	`namespace__componentName` 形式の Lightning コンポーネント名。	はい

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

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

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

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

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

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

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

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

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

プロパティ	型	説明	必須
`contentTypeName`	String	Salesforce CMS コンテンツタイプの名前。	はい
`contentKey`	String	CMS を識別する一意のコンテンツキー。	はい

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

プロパティ	型	説明	必須
`actionName`	String	起動するアクション名。有効な値には `clone`、`edit`、`view` があります。エクスペリエンスビルダーサイトでは、`clone` や `edit` はサポートされていません。	はい
`objectApiName`	String	レコードのオブジェクトの API 参照名。ルックアップでは省略可能です。	対象はエクスペリエンスビルダー LWR サイトのみ: はい。対象はすべてのコンテナ: いいえ。
`recordId`	String	18 文字のレコード ID。	はい

状態

プロパティ	型	説明	必須かどうか
`nooverride`	String	標準アクションを使用するには、このプロパティに `1` などの任意の値を割り当てます。上書きアクションを使用するには、このプロパティを一切含めないようにします。	いいえ

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

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

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

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

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

外部 URL。

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

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

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

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

関連トピック