FlexiPage

Represents a Lightning Page. A Lightning Page is the home page for an app that appears as a menu item in the Salesforce1 navigation menu. Includes access to the associated FlexiPage object in the Salesforce Metadata API. Available from API version 31.0 or later.

These app pages are known as FlexiPages in the API, but are referred to as Lightning Pages in the rest of the Salesforce documentation and UI.

Note

Supported SOAP Calls

create(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

GET, HEAD

Fields

Field	Details
Description	Type string Properties Filter, Group, Nillable, Sort Description The email page description. This field can be useful to describe the reason for creating the page or its intended use.
DeveloperName	Type string Properties Filter, Group, Sort Description The API name of the Lightning Page.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated FlexiPage object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
MasterLabel	Type string Properties Filter, Group, Sort Description The page��s label.
Metadata	Type FlexiPageMetadata Properties Create, Nillable, Update Description Lightning Page metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace of the package of which the flexipage is a part.
ParentFlexiPage	Type string Properties Filter, Group, Nillable, Sort Description This field is reserved for future use. Available in API version 35.0 or later.
SobjectType	Type string Properties Filter, Group, Nillable, Sort Description This field is reserved for future use. Once the value of this field is set, it can’t be changed. Available in API version 33.0 or later.
Type	Type picklist Properties Filter, Group, Restricted picklistSort Description Required. The type of the Lightning Page. Available in API version 32.0 or later. In API version 32.0 and later, this field can only have a value of AppPage.

Sample Code

This code sample creates a Lightning Page with a single Recent Items component, that shows recently used Accounts and MyCustomObject__cs

1ComponentInstance recentItems = new ComponentInstance();
2 recentItems.setComponentName("flexipage:recentItems");
3 ComponentInstanceProperty cip = new ComponentInstanceProperty();
4 cip.setName("entityNames");
5 cip.setValue("Account,MyCustomObject__c");
6 recentItems.setComponentInstanceProperties(new ComponentInstanceProperty[]{cip});
7
8FlexiPageRegion mainRegion = createRegion("main");
9mainRegion.setComponentInstances(new ComponentInstance[] { recentItems });
10
11FlexiPageMetadata fpMetadata = new FlexiPageMetadata();
12fpMetadata.setFlexiPageRegions(new FlexiPageRegion[]{mainRegion});
13fpMetadata.setMasterLabel("My FlexiPage");
14fpMetadata.setDescription("A FlexiPage with a recent items component");
15
16FlexiPage flexiPage = new FlexiPage();
17flexiPage.setFullName("MyFlexiPageDevName");
18flexiPage.setMetadata(fp);
19
20// Create
21SaveResult saveResult = soapConnection.create(new SObject[] { flexiPage });

Force.com Tooling API

FlexiPage

Supported SOAP Calls

Supported REST HTTP Methods

Fields

Sample Code