メタデータ API 開発者ガイド
jFlexiPage
Metadata メタデータ型を拡張し、その fullName 項目を継承します。
Lightning ページは、いくつかの場所で使用されます。
- Salesforce1 では、Lightning ページはナビゲーションメニューに表示されるアプリケーションのホームページです。
- Lightning Experienceでは、Lightning ページは、アプリケーションのホームページ、レコードページやホームページのレイアウトのカスタマイズ、または Lightning アプリケーションのユーティリティバーなどの用途で使用できます。
Lightning ページについての詳細は、Salesforce ヘルプを参照してください。
ファイルのサフィックスおよびディレクトリの場所
FlexiPage コンポーネントのサフィックスは .flexipage であり、flexipages フォルダに保存されます。
バージョン
FlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | Lightning ページの説明テキスト (省略可能)。 |
| flexiPageRegions | FlexiPageRegion[] | 必須。ページの領域のリスト。 |
| masterLabel | string | 必須。[設定] に表示されるこの FlexiPage の表示ラベル。 |
| pageTemplate | string | 非推奨。この項目は API バージョン 33.0 から 38.0 でのみ使用してください。それ以降のバージョンでは、template を使用してください。 |
| parentFlexiPage | string | このページが動作を継承する元となる FlexiPage の名前。 この項目は、API バージョン 37.0 以降で使用できます。 |
| platformActionList | PlatformActionList | Lightning ページに表示されるすべてのアクションとその順序のリスト。Salesforce1 では、アクションバーに表示されるアクション。 この項目は API バージョン 34.0 以降で使用できます。 |
| quickActionList | QuickActionList | Lightning ページに関連付けられたクイックアクションのリスト。 |
| sobjectType | string |
FlexiPage が関連付けられているオブジェクト。種別が AppPage または HomePage の Lightning ページ では、この項目は null です。 この項目の値を設定すると、変更はできません。 この項目は、API バージョン 37.0 以降で使用できます。 |
| template | FlexiPageTemplateInstance |
必須。FlexiPage に関連付けられているテンプレート。 この項目は API バージョン 39.0 以降で使用できます。 |
| type | FlexiPageType (string 型の列挙) |
必須。ページの種別。API バージョン 32.0 ～ 36.0 では、この項目には値 AppPage しか設定できません。 有効な値は、次のとおりです。
この項目は API バージョン 32.0 以降で使用できます。 |
FlexiPageRegion
FlexiPageRegion は、ページ領域のプロパティを表します。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| appendable | RegionFlagStatus (string 型の列挙) | この項目は、将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
| componentInstances | ComponentInstance[] | コンポーネントインスタンスのプロパティと名前。 |
| mode | FlexiPageRegionMode (string 型の列挙) | この項目は、将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
| name | string | 必須。FlexiPage 範囲の一意の名前。 |
| prependable | RegionFlagStatus (string 型の列挙) | この項目は、将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
| replaceable | RegionFlagStatus (string 型の列挙) | この項目は、将来の使用のために予約されています。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
| type | FlexiPageRegionType (string 型の列挙) | 必須。FlexiPage 範囲の種別。 有効な値は、次のとおりです。
この項目は、API バージョン 35.0 以降で使用できます。 |
ComponentInstance
フィルタリストなど、ページ内のコンポーネントのインスタンス。
| 項目名 | データ型 | 説明 |
|---|---|---|
| componentInstanceProperties | ComponentInstanceProperty[] | コンポーネントインスタンスの単一プロパティの値。コンポーネントインスタンスにはプロパティがない場合もあります。 |
| componentName | string | 必須。コンポーネントの単一インスタンスの名前。 |
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 に設定します。 |
タブコンポーネントに標準表示ラベル (活動、コラボレーション、詳細など) を付ける場合、name 項目が title に設定されていると、表示ラベルではなくシステム定義値が value 項目で使用されます。システム定義値の例として、次のようなものがあります。
- Standard.Tab.activity
- Standard.Tab.collaborate
- Standard.Tab.detail
- Standard.Tab.feed
- Standard.Tab.preview
- Standard.Tab.relatedLists
たとえば、Lightning ページに標準表示ラベル「活動」のあるタブが含まれているとします。そのページの定義をクエリすると、value には表示ラベルではなく、タブのシステム定義名が表示されます。
1<componentInstances>
2 <componentInstanceProperties>
3 <name>title</name>
4 <value>Standard.Tab.activity</value>
5 </componentInstanceProperties>
6 <componentName>flexipage:tab</componentName>
7</componentInstances>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 になります。標準ボタンおよび生産性アクションには、サブタイプはありません。 |
FlexiPageTemplateInstance
FlexiPageTemplateInstance は FlexiPage テンプレートのインスタンスを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| name | string | 必須。テンプレートの単一インスタンスの名前。 |
| properties | ComponentInstanceProperty[] |
テンプレートインスタンスの単一プロパティの値。 CommThemeLayoutPage でのみ有効。FlexiPage テンプレートに関連付けられている各テーマレイアウトプロパティの名前と値のペアが含まれます。コミュニティビルダーでは、テーマレイアウトとそのプロパティは [テーマ] 領域に表示されます。 |
宣言的なメタデータの定義のサンプル
次に、ユーザの出張、経費報告、および他の関連データを追跡する出張アプリケーションのサンプル XML FlexiPage コンポーネント定義を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>Page to view recent trips</description>
4 <flexiPageRegions>
5 <componentInstances>
6 <componentInstanceProperties>
7 <name>entityName</name>
8 <value>Trips__c</value>
9 </componentInstanceProperties>
10 <componentInstanceProperties>
11 <name>filterName</name>
12 <value>My_Trips</value>
13 </componentInstanceProperties>
14 <componentName>flexipage:filterListCard</componentName>
15 </componentInstances>
16 <componentInstances>
17 <componentInstanceProperties>
18 <name>entityName</name>
19 <value>Expense_Report__c</value>
20 </componentInstanceProperties>
21 <componentInstanceProperties>
22 <name>filterName</name>
23 <value>My_Reports</value>
24 </componentInstanceProperties>
25 <componentName>flexipage:filterListCard</componentName>
26 </componentInstances>
27 <componentInstances>
28 <componentInstanceProperties>
29 <name>entityNames</name>
30 <value>["User","Trips__c","Expense__c","Receipt__c"]</value>
31 </componentInstanceProperties>
32 <componentName>flexipage:recentItems</componentName>
33 </componentInstances>
34 <name>main</name>
35 </flexiPageRegions>
36 <masterLabel>My Travel, Inc.</masterLabel>
37 <quickActionList>
38 <quickActionListItems>
39 <quickActionName>customAction1</quickActionName>
40 </quickActionListItems>
41 <quickActionListItems>
42 <quickActionName>customAction2</quickActionName>
43 </quickActionListItems>
44 </quickActionList>
45 <type>AppPage</type>
46</FlexiPage>FlexiPage コンポーネント定義を参照するサンプルの package.xml ファイルを次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <fullName>Travel, Inc.</fullName>
4 <types>
5 <members>TravelIncFlexiPage</members>
6 <name>CustomTab</name>
7 </types>
8 <types>
9 <members>TravelIncFlexiPage</members>
10 <name>FlexiPage</name>
11 </types>
12 <types>
13 <members>TravelIncQuickActions</members>
14 <name>QuickAction</name>
15 </types>
16 <version>29.0</version>
17</Package>