describeFlexiPages()
一連の Lightning ページに関するメタデータ詳細を取得します。Lightning ページは、Salesforce1 ナビゲーションメニューのメニュー項目として表示されるモバイルアプリケーションのホームページです。
構文
1DescribeFlexiPageResult[] = connection.describeFlexiPages(string flexiPageNames[]);使用方法
このコールを使用して、指定された Lightning ページに関する情報を取得します。このコールは、各 Lightning ページのレイアウトや関連付けられた QuickAction など、一連の Lightning ページに関するメタデータを返します。
flexiPageNames に対して空のリストを指定すると、Lightning ページは返されません。
サンプルコード —Java
このサンプルでは、Lightning ページの取得方法を示します。記述する Lightning ページの名前を使用して、describeFlexiPage() をコールします。Lightning ページを取得すると、範囲、コンポーネント、およびプロパティが出力されます。
1public void describeFlexiPageSample() {
2 try {
3 // Retrieve a single FlexiPage
4 String flexiPageName = "MyFlexiPage";
5 DescribeFlexiPageResult[] result = null;
6 result = connection.describeFlexiPages(new String[]{flexiPageName});
7 String msg = String.format("There are %s FlexiPages described in the response", result.length);
8 System.out.println(msg);
9 DescribeFlexiPageResult page = result[0];
10
11 // Iterate over the regions of the FlexiPage
12 for (DescribeFlexiPageRegion region : page.getRegions()) {
13 msg = String.format("Region: %s", region.getName());
14
15 // Iterate over the components in each region
16 for (DescribeComponentInstance cmp : region.getComponents()) {
17 String fullComponentName = cmp.getTypeNamespace() + ":" + cmp.getTypeName();
18 System.out.println("Component: " + fullComponentName);
19
20 // Iterate over the properties of each component
21 for (DescribeComponentInstanceProperty prop : cmp.getProperties()) {
22 msg = String.format("Property [%s] has value [%s]", prop.getName(), prop.getValue());
23 System.out.println(msg);
24 }
25 }
26 }
27 } catch (ConnectionException ce) {
28 ce.printStackTrace();
29 }
30}引数
| 名前 | 型 | 説明 |
|---|---|---|
| flexiPages | string[] | 取得する Lightning ページの配列。 |
| contexts | FlexipageContext[] | Account や Contact など、FlexiPage のコンテキストの配列。この引数は、種別が AppPage のページには必要ありません。 API バージョン 35.0 以降で使用できます。 |