XML 設定ファイルの要素
HTML テンプレートディレクティブ
HTML テンプレートエラー
デコレータ
@salesforce モジュール
PageReference の型
Lightning Experience、エクスペリエンスビルダーサイト、または Salesforce モバイルアプリケーションでのナビゲーション用に PageReference オブジェクトを定義します。PageReference 型によって一意の URL が生成され、その型のすべてのページに適用される属性が定義されます。エクスペリエンスビルダーサイトでは、ページ種別によっては、PageReference プロパティの要件が LWR サイトと Aura サイトとで異なる場合があります。
PageReference オブジェクトは、lightning/navigation モジュールの NavigationMixin 関数で使用します。PageReference を使用した移動についての詳細は、「さまざまなページ種別への移動」を参照してください。
Tip
サポートされるページ参照の種別を次に示します。
各種別に記載されているように、PageReference オブジェクトはエクスペリエンスビルダーサイトでは制限付きでサポートされます。これらは、Lightning Out ではサポートされていません。
Note
PageReference オブジェクトを使用した移動方法は、Aura イベントを使用して移動する従来の方法に置き換わるものです。たとえば、force:navigateToURL を使用する代わりに、lightning/navigation モジュールを使用して standard__webPage ページ種別で Web ページに移動します。「イベントの移行」を参照してください。
組織のアプリケーションランチャーから使用できる標準またはカスタムアプリケーション。この種別を使用すると、ユーザを特定のアプリケーションやアプリケーション内のページに移動するカスタムナビゲーションコンポーネントを作成できます。接続アプリケーションはサポートされません。
pageRef を使用してユーザを別のアプリケーションに移動する場合、このアプリケーションは、デフォルトでは同じウィンドウで開きます。新しいタブでリンクを開くには、ナビゲーションサービスに関するドキュメントを参照してください。
Note
1standard__app;Lightning Experience
| プロパティ | 型 | 説明 | 廃止? |
|---|---|---|---|
appTarget | String | 移動先のアプリケーション。appId または appDeveloperName を appTarget に渡します。
standard__ です。カスタムアプリケーションの場合、名前空間は c__ です。管理パッケージの場合、名前空間は、パッケージに登録された名前空間です。 | はい |
pageRef | PageREference | 移動先のアプリケーション内の特定の場所を指定します。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}1/lightning/app/{appTarget}{...pageRef}appId を使用して、アプリケーションのホームページに移動
1/lightning/app/06mRM0000008dNrYAIappId を使用して、アプリケーションのオブジェクトレコードのページに移動
1/lightning/app/06mRM0000008dNrYAI/o/Case/homeappDeveloperName を使用して、アプリケーションのホームページに移動
1/lightning/app/standard__LightningSalesappDeveloperName を使用して、アプリケーションのオブジェクトレコードのページに移動
1/lightning/app/standard__LightningSales/o/Case/home外部レコードを操作するページ。現在、CMS Connect ページをサポートしています。
1comm__externalRecordPage;エクスペリエンスビルダー Aura サイト
| プロパティ | 型 | 説明 | 必須かどうか |
|---|---|---|---|
recordId | String | 外部レコード ID。 | はい |
objectType | String | 外部レコード種別。現在サポートしているのは、CMS Connect 用の cms のみです。 | はい |
objectInfo | Object | objectType のレコードを識別するための追加情報。 | はい |
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}1/{baseUrl}/{recordId}/{recordName}組織内の特定のレコードに対する外部リレーションを操作するページ。現在サポートしているのは、Quip 関連リストページのみです。
1comm__externalRecordRelationshipPage;エクスペリエンスビルダー Aura サイト
| プロパティ | 型 | 説明 | 必須かどうか |
|---|---|---|---|
recordId | String | 18 文字のレコード ID。 | はい |
objectType | String | 外部レコード種別。現在サポートしているのは、Quip ドキュメント用の quip のみです。 | はい |
1{
2 type: "comm__externalRecordRelationshipPage",
3 attributes: {
4 recordId: "001xx000003DGg0AAG",
5 objectType: "quip",1/{baseUrl}/{recordId}Lightning コンポーネント。アドレス指定可能な Lightning Web コンポーネントを作成するには、lightning:isUrlAddressable インターフェースを実装する Aura コンポーネントにそのコンポーネントを埋め込みます。
1standard__component;Lightning Experience、Salesforce モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
componentName | String | namespace__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 モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
articleType | String | ナレッジ記事レコードの articleType API 参照名。エクスペリエンスビルダーサイトでは、articleType は無視されます。 | はい |
urlName | String | 参照先 KnowledgeArticleVersion レコードの urlName 項目の値。urlName は記事の URL です。 | はい |
1{
2 type: 'standard__knowledgeArticlePage',
3 attributes: {
4 articleType: 'Briefings',
5 urlName: 'February-2017'
6 }
7}認証してエクスペリエンスビルダーサイトに入るためのページ。
1comm__loginPage;エクスペリエンスビルダーサイト
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
actionName | String | 実行するログイン関連のアクション。可能な値は次のとおりです。
| はい |
1{
2 type: 'comm__loginPage',
3 attributes: {
4 actionName: 'login'
5 }
6}一意の名前が付けられたエクスペリエンスビルダーサイトの CMS コンテンツページ。
1standard__managedContentPage;エクスペリエンスビルダーサイト
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
contentTypeName | String | Salesforce CMS コンテンツタイプの名前。 | はい |
contentKey | String | CMS を識別する一意のコンテンツキー。 | はい |
1{
2 type: 'standard__managedContentPage',
3 attributes :{
4 'contentTypeName': 'news',
5 'contentKey': 'MCOMALJDRAYFFSFPNBQONYXVFHOA'
6 }
7}エクスペリエンスビルダーサイトで使用される一意の名前が付けられた標準ページ。エラーが発生すると、エラービューが読み込まれ、URL は更新されません。
1comm__namedPage;エクスペリエンスビルダーサイト
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
name | String | エクスペリエンスビルダーページの一意の名前。name の値は、サポートされるページの [API 参照名] の値になります。新しいページを作成するときは、[API 参照名] 項目の定義のみを行うことができます。この名前は、一意にする必要があります。[API 参照名] は、ページ作成時に定義しない場合は、自動的に生成されます。home の値は、組織の任意のエクスペリエンスビルダーサイトのランディングページ用に予約されています。エクスペリエンスビルダーサイトでサポートされるページは次の通りです。
| はい |
1{
2 type: 'comm__namedPage',
3 attributes: {
4 name: 'Home'
5 }
6}一意の名前が付けられた標準ページ。エラーが発生すると、エラービューが読み込まれ、URL は更新されません。
1standard__namedPage;Lightning Experience、Salesforce モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
pageName | String | ページの一意の名前。可能な値は次のとおりです。
| はい |
1{
2 type: 'standard__namedPage',
3 attributes: {
4 pageName: 'home'
5 }
6}カスタムタブに対応付けられたコンテンツを表示するページ。Visualforce タブ、Web タブ、Lightning ページ、Lightning コンポーネントタブがサポートされています。
1standard__navItemPage;Lightning Experience、Salesforce モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
apiName | String | カスタムタブの一意の名前。 | はい |
1{
2 type: 'standard__navItemPage',
3 attributes: {
4 apiName: 'MyCustomTabName'
5 }
6}例については、「さまざまなページ種別への移動」を参照してください。
組織内の標準またはカスタムオブジェクトを操作するページ。そのオブジェクトの標準アクションがサポートされます。
1standard__objectPage;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。 | いいえ |
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 モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
actionName | String | 起動するアクション名。有効な値には clone、edit、view があります。エクスペリエンスビルダーサイトでは、clone や edit はサポートされていません。 | はい |
objectApiName | String | レコードのオブジェクトの API 参照名。ルックアップでは省略可能です。 |
|
recordId | String | 18 文字のレコード ID。 | はい |
| プロパティ | 型 | 説明 | 必須かどうか |
|---|---|---|---|
nooverride | String | 標準アクションを使用するには、このプロパティに 1 などの任意の値を割り当てます。上書きアクションを使用するには、このプロパティを一切含めないようにします。 | いいえ |
1{
2 type: 'standard__recordPage',
3 attributes: {
4 recordId: '001xx000003DGg0AAG',
5 objectApiName: 'PersonAccount',
6 actionName: 'view'
7 }
8}例については、「さまざまなページ種別への移動」を参照してください。
組織内の特定のレコードに対するリレーションを操作するページ。関連リストのみがサポートされています。
1standard__recordRelationshipPage;Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
actionName | String | 起動するアクション名。view のみがサポートされています。 | はい |
objectApiName | String | リレーションを定義するオブジェクトの API 参照名。ルックアップでは省略可能です。 |
|
recordId | String | リレーションを定義するレコードの 18 文字のレコード ID。 | はい |
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。
Lightning Web コンポーネントを Aura ベースのエクスペリエンスビルダーサイトで使用する場合は、一部の Salesforce URL にサイト固有の処理があることに注意してください。たとえば、/apex/ URL は /sfdcpage/ に翻訳されます。Visualforce ページは iFrame でサイト内に埋め込まれます。これは force:navigateToURL Aura イベントを使用した場合と同じ動作です。新しいタブで /apex/ を直接開くなど、URL に直接アクセスする場合は window.open を使用してください。
Tip
1standard__webPage;Lightning Experience、エクスペリエンスビルダーサイト、Salesforce モバイルアプリケーション
| プロパティ | 型 | 説明 | 必須 |
|---|---|---|---|
url | String | 移動先ページの URL。 | はい |
1{
2 type: 'standard__webPage',
3 attributes: {
4 url: 'http://salesforce.com'
5 }
6}例については、「さまざまなページ種別への移動」を参照してください。
関連トピック
The Japanese Summer '24 guide is now live