FlexiPage | メタデータ API 開発者ガイド

Lightning ページに関連付けられたメタデータを表します。Lightning ページは、Salesforce1 ナビゲーションメニューのメニュー項目として表示されるモバイルアプリケーションのホームページです。Metadata メタデータ型を拡張し、その fullName 項目を継承します。

これらのアプリケーションページは、API では FlexiPage と呼ばれますが、残りの Salesforce ドキュメントおよび UI では Lightning ページと呼ばれます。

メモ

Lightning ページについての詳細は、Salesforce ヘルプを参照してください。

FlexiPage コンポーネントは、Salesforce1 でのみサポートされています。Salesforce1 についての詳細は、Salesforce ヘルプを参照してください。

メモ

ファイルのサフィックスおよびディレクトリの場所

FlexiPage コンポーネントのサフィックスは .flexipage であり、flexipages フォルダに保存されます。

バージョン

FlexiPage コンポーネントは、API バージョン 29.0 以降で使用できます。

項目

項目名	データ型	説明
description	string	Lightning ページの説明テキスト (省略可能)。
flexiPageRegions	FlexiPageRegion[]	必須。ページの領域。必ず 1 つの領域がある必要があります。
masterLabel	string	必須。[設定] に表示されるこの FlexiPage の表示ラベル。
pageTemplate	string	必須。FlexiPage に関連付けられているテンプレート。この項目は、API バージョン 33.0 以降で使用できます。
platformActionList	PlatformActionList	Lightning ページの Salesforce1 アクションバーに表示されるアクションのリストとその順序。この項目は API バージョン 34.0 以降で使用できます。
quickActionList	QuickActionList	Lightning ページに関連付けられたクイックアクションのリスト。
sobjectType	string	この項目は、将来の使用のために予約されています。この項目は、API バージョン 33.0 以降で使用できます。
type	FlexiPageType (string 型の列挙)	必須。ページの種別。API バージョン 32.0 では、この項目には値 `AppPage` しか設定できません。有効な値は、次のとおりです。 `AppPage` — カスタムアプリケーションのホームページとして使用される Lightning ページ。この項目は API バージョン 32.0 以降で使用できます。

FlexiPageRegion

FlexiPageRegion は、ページ領域のプロパティを表します。FlexiPage ごとに 1 つの範囲があります。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。

項目名	データ型	説明
componentInstances	ComponentInstance[]	コンポーネントインスタンスのプロパティと名前。
name	string	必須。FlexiPage 範囲の一意の名前。 `main` である必要があります。

ComponentInstance

フィルタリストなど、ページ内のコンポーネントのインスタンス。

項目名	データ型	説明
componentInstanceProperties	ComponentInstanceProperty[]	コンポーネントインスタンスの単一プロパティの値。コンポーネントインスタンスにはプロパティがない場合もあります。
componentName	string	必須。コンポーネントの単一インスタンスの名前。

ComponentInstanceProperty

コンポーネントインスタンスの単一プロパティの値。

項目名	データ型	説明
name	string	コンポーネントインスタンス内で一意のプロパティ名。
value	string	プロパティの参照または値。

PlatformActionList

PlatformActionList は、レイアウトの Salesforce1 アクションバーに表示されるアクションのリストとその順序を表します。API バージョン 34.0 以降で利用できます。

項目名	データ型	説明
actionListContext	PlatformActionListContext (string 型の列挙)	必須。アクションリストのコンテキスト。有効な値は、次のとおりです。 `Chatter` `FeedElement` `FlexiPage` `Global` `ListView` `ListViewRecord` `MruList` `MruRow` `Record` `RelatedList` `RelatedListRecord`
platformActionListItems	PlatformActionListItem[]	PlatformActionList のアクション。
relatedSourceEntity	string	ActionListContext が RelatedList または RelatedListRecord の場合、この項目はアクションが属する関連リストの API 名を表します。

PlatformActionListItem

PlatformActionListItem は PlatformActionList のアクションを表します。API バージョン 34.0 以降で利用できます。

項目名	データ型	説明
actionName	string	リスト内のアクションの API 名。
actionType	PlatformActionType (string 型の列挙)	アクションの種別。有効な値は、次のとおりです。 `ActionLink` `CustomButton` `ProductivityAction` `QuickAction` `StandardButton`
sortOrder	int	リスト内のアクションの位置。
subtype	string	アクションのサブタイプ。クイックアクションの場合、サブタイプは `QuickActionType` になります。カスタムボタンの場合、サブタイプは `WebLinkTypeEnum` になります。アクションリンクの場合、サブタイプは `Api`、`ApiAsync`、`Download`、`Ui` になります。標準ボタンおよび生産性アクションには、サブタイプはありません。

宣言的なメタデータの定義のサンプル

次に、ユーザの出張、経費報告、および他の関連データを追跡する出張アプリケーションのサンプル XML FlexiPage コンポーネント定義を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">
3   <flexiPageRegions>
4   <description>Page to view recent trips</description>
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</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>