メタデータ API 開発者ガイド
jFlexiPage
- Salesforce アプリケーションでは、Lightning ページはナビゲーションメニューに表示されるアプリケーションのホームページです。
- Lightning Experience では、Lightning ページを次の目的で使用できます。
- レコードページ、Salesforce ホームページ、Outlook および Gmail インテグレーションのメールアプリケーションペインのレイアウトをカスタマイズする。
- アプリケーションのホームページとして。
- Lightning アプリケーションのユーティリティバーとして。
Lightning ページについての詳細は、Salesforce ヘルプを参照してください。
ファイルのサフィックスおよびディレクトリの場所
FlexiPage コンポーネントのサフィックスは .flexipage で、flexipages フォルダに保存されます。
バージョン
FlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| description | string | Lightning ページの説明テキスト (省略可能)。 |
| flexiPageRegions | FlexiPageRegion[] | ページの領域のリスト。 |
| masterLabel | string | 必須。[設定] に表示される Lightning ページの表示ラベル。 |
| pageTemplate | string | 非推奨。この項目は API バージョン 33.0 から 38.0 でのみ使用してください。それ以降のバージョンでは、template を使用してください。 |
| parentFlexiPage | string | このページが動作を継承する元となる Lightning ページの名前。 この項目は、API バージョン 37.0 以降で使用できます。 |
| platformActionList | PlatformActionList | Lightning アプリケーションページに表示されるすべてのアクションとその順序のリスト。Salesforce モバイルアプリケーションの場合、アクションはアクションバーに表示されます。 この項目は、API バージョン 34.0 以降で使用できます。 |
| quickActionList | QuickActionList | Lightning ページに関連付けられたクイックアクションのリスト。 |
| sobjectType | string |
Lightning ページが関連付けられているオブジェクト。種別が AppPage または HomePage の Lightning ページ では、この項目は null です。 この項目の値を設定すると、変更はできません。 この項目は、API バージョン 37.0 以降で使用できます。 |
| template | FlexiPageTemplateInstance |
必須。Lightning ページに関連付けられているテンプレート。 この項目は、API バージョン 39.0 以降で使用できます。 |
| type | FlexiPageType (string 型の列挙) |
必須。ページの種別。API バージョン 32.0 ～ 36.0 では、この項目には値 AppPage しか設定できません。 有効な値は、次のとおりです。
この項目は、API バージョン 32.0 以降で使用できます。 |
FlexiPageRegion
FlexiPageRegion は、ページ領域のプロパティを表します。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| appendable | RegionFlagStatus (string 型の列挙) | この値はコミュニティにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、replaceable および prependable と組み合わせて評価されます。
この項目は、API バージョン 35.0 以降で使用できます。 |
| componentInstances | ComponentInstance[] | コンポーネントインスタンスのプロパティと名前。 |
| mode | FlexiPageRegionMode (string 型の列挙) | この項目は、将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
| name | string | 必須。FlexiPage 範囲の一意の名前。 |
| prependable | RegionFlagStatus (string 型の列挙) | この値はコミュニティにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、appendable および replaceable と組み合わせて評価されます。
この項目は、API バージョン 35.0 以降で使用できます。 |
| replaceable | RegionFlagStatus (string 型の列挙) | この値はコミュニティにおいて API バージョン 45.0 以降で使用できますが、他のすべての領域では将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、appendable および prependable と組み合わせて評価されます。
この項目は、API バージョン 35.0 以降で使用できます。 |
| type | FlexiPageRegionType (string 型の列挙) | 必須。FlexiPage 範囲の種別。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
ComponentInstance
フィルタリストなど、ページ内のコンポーネントのインスタンス。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| componentInstanceProperties | ComponentInstanceProperty[] | コンポーネントインスタンスの単一プロパティの値。 |
| componentName | string | 必須。コンポーネントの単一インスタンスの名前。 |
| visibilityRule | UiFormulaRule | コンポーネントをページ上に表示する条件を定義する 1 つ以上の条件のセット。 ルールが true と評価されると、コンポーネントがページに表示されます。false の場合は表示されません。この項目が null の場合、デフォルトではコンポーネントが表示されます。 この項目は、API バージョン 41.0 以降で使用できます。 |
ComponentInstanceProperty
コンポーネントインスタンスの単一プロパティの値。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | コンポーネントインスタンス内で一意のプロパティ名。Lightning コンポーネントでは、この値は .cmp ファイルで定義される <aura:attribute> です。 |
| type | ComponentInstancePropertyTypeEnum (string 型の列挙) |
この項目値が null の場合、ComponentInstanceProperty の値が Lightning コンポーネントに適用されます。この項目値が decorator の場合、ComponentInstanceProperty の値が Lightning コンポーネントのコンポーネントデコレータに適用されます。 コンポーネントデコレータは、Lightning コンポーネントを囲むラッパーです。このデコレータでは、Lightning Experience に特定のページを表示するときに、他の機能をコンポーネントに適用できます。たとえば、Lightning Experience ユーティリティバー上のコンポーネントを囲むコンポーネントデコレータを設定して、開いたときのコンポーネントの高さや幅を設定できます。UtilityBar は、コンポーネントデコレータをサポートする唯一のページ種別です。 この項目は、API バージョン 38.0 以降で使用できます。 |
| value | string | プロパティの参照または値。 [関連リスト] コンポーネントを定義する場合、親レコードを使用するには、parentFieldApiName 値を object.field_name に設定します。親レコードを使用しない場合は、値を object.Id に設定します。 |
- Standard.Tab.activity
- Standard.Tab.collaborate
- Standard.Tab.detail
- Standard.Tab.feed
- Standard.Tab.preview
- Standard.Tab.relatedLists
UiFormulaRule
コンポーネントを Lightning ページ上に表示する条件を定義する 1 つ以上の条件のセット。たとえば、[金額] が $1,000,000 よりも大きいとき、商談ページにリッチテキストコンポーネントを表示する条件を作成できます。API バージョン 41.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| booleanFilter | string | 高度な検索条件を指定します (1 AND 2 など)。 |
| criteria | UiFormulaCriterion[] | 評価時にコンポーネントの表示を決定する 1 つ以上の条件のリスト。 |
FlexiPageTemplateInstance
FlexiPageTemplateInstance は Lightning ページテンプレートのインスタンスを表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。テンプレートの単一インスタンスの名前。 |
| properties | ComponentInstanceProperty[] |
テンプレートインスタンスの単一プロパティの値。 CommThemeLayoutPage でのみ有効。ページテンプレートに関連付けられている各テーマレイアウトプロパティの名前と値のペアが含まれます。コミュニティビルダーでは、テーマレイアウトとそのプロパティは [テーマ] 領域に表示されます。 |
PlatformActionList
Lightning アプリケーションページに表示されるアクションとその順序のリストを表す PlatformActionList。API バージョン 34.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionListContext | PlatformActionListContext (string 型の列挙) | 必須。アクションリストのコンテキスト。有効な値は、次のとおりです。
|
| platformActionListItems | PlatformActionListItem[] | PlatformActionList のアクション。 |
| relatedSourceEntity | string | ActionListContext が RelatedList または RelatedListRecord の場合、この項目はアクションが属する関連リストの API 名を表します。 |
PlatformActionListItem
PlatformActionListItem は PlatformActionList のアクションを表します。API バージョン 34.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| actionName | string | 必須。リストのアクションの API 参照名。 |
| actionType | PlatformActionType (string 型の列挙) | 必須。アクションの種別。有効な値は、次のとおりです。
|
| sortOrder | int | 必須。リスト内のアクションの位置。 |
| subtype | string | アクションのサブタイプ。クイックアクションの場合、サブタイプは QuickActionType になります。カスタムボタンの場合、サブタイプは WebLinkTypeEnum になります。アクションリンクの場合、サブタイプは Api、ApiAsync、Download、Ui になります。標準ボタンおよび生産性アクションには、サブタイプはありません。 |
UiFormulaCriterion
評価時に Lightning ページのコンポーネントの表示を定義する 1 つの条件。API バージョン 41.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| leftValue | string | 必須。条件のベースとなる項目。たとえば、AMOUNT のようになります。 |
| operator | string | 必須。データを絞り込むために使用される演算子を定義します。有効な値は、次のとおりです。
|
| rightValue | string | コンポーネントの表示を評価する値。たとえば、1000000 です。 |
- {!$Client.FormFactor} — ページを表示するデバイスに基づいてコンポーネントの表示を制御するには、この式を使用します。有効な値は Small (電話)、Medium (タブレット)、Large (Lightning Experience デスクトップ) です。アプリケーションページでのみサポートされます。
- {!$Permission.CustomPermission.permissionName} — Lightning ページを参照しているユーザのカスタム権限に基づいてコンポーネントの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。
- {!$Permission.StandardPermission.permissionName} — Lightning ページを参照しているユーザの標準権限に基づいてコンポーネントの表示を制御するには、この式を使用します。アプリケーション、ホーム、およびレコードページでのみサポートされます。
- {!Record.field} — レコードページでのみサポートされます。
- {!$User.field} — アプリケーション、ホーム、およびレコードページでのみサポートされます。
たとえば、電話に表示する場合にのみコンポーネントを表示するには、条件 {!$Client.FormFactor} EQUAL "SMALL" を追加します。また、システム管理者にのみコンポーネントを表示するには、{!$User.Profile.Name} EQUAL "System Administrator" を使用します。
コンポーネントの表示ルール内の式は 5 個の項目までまたがることができます。たとえば、{!Record.Account.Owner.Manager.Manager.Manager.LastName} は、6 個の項目にまたがっているためサポートされません。
宣言的なメタデータの定義のサンプル
FlexiPage コンポーネント定義を参照するサンプルの package.xml ファイルを次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。