この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

describeFlexiPages()

一連の Lightning ページに関するメタデータ詳細を取得します。Lightning ページは、Salesforce1 ナビゲーションメニューのメニュー項目として表示されるモバイルアプリケーションのホームページです。

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

メモ

構文

1DescribeFlexiPageResult[] = connection.describeFlexiPages(string flexiPageNames[]);

使用方法

このコールを使用して、指定された Lightning ページに関する情報を取得します。このコールは、各 Lightning ページのレイアウトや関連付けられた QuickAction など、一連の Lightning ページに関するメタデータを返します。

flexiPageNames に対して空のリストを指定すると、Lightning ページは返されません。

このコールは高度な API コールであり、通常は、モバイルデバイスで出力を生成するためのカスタムページ表示コードを記述してから出力結果を表示する前に 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 以降で使用できます。

FlexipageContext

Account や Contact など、FlexiPage のコンテキストを表します。種別が AppPage のページには適用されません。API バージョン 35.0 以降で使用できます。

名前 説明
type string 型の FlexipageContextTypeEnum 列挙 FlexipageContext の種別。有効な値は、次のとおりです。
  • ENTITYNAME
value string FlexipageContext の値。