Newer Version Available

This content describes an older version of this product. View Latest

describeFlexiPages()

Retrieves metadata details about a set of Flexible Pages. A Flexible Page is the home page for a mobile app that appears as a menu item in the Salesforce1 navigation menu.

Syntax

Usage

Use this call to retrieve information about the specified Flexible Pages. This call returns metadata about a set of Flexible Pages, such as each Flexible Page’s layout and associated QuickActions.

If you supply an empty list for flexiPageNames, no Flexible Pages are returned.

This call is an advanced API call that is typically used by partners who have written custom page rendering code for generating output on a mobile device and need to examine the layout details of a Flexible Page before rendering the output.

Note

Sample Code—Java

This sample shows how to get a Flexible Page. It calls describeFlexiPage() with the name of a Flexible Page to describe.  After getting the Flexible Page, it  prints out the regions, components and properties.

Arguments

Name Type Description
flexiPages string[] An array of Flexible Pages to be retrieved.