SOAP API 開発者ガイド
jDescribeFlexiPageResult
describeFlexiPages() コールは、各 Lightning ページに関連付けられた範囲とアクションのリストなど、渡された flexiPages に関する情報を含む DescribeFlexiPageResult オブジェクトの配列を返します。
| 名前 | 型 | 説明 |
|---|---|---|
| id | ID | Lightning ページの ID。 |
| label | string | Lightning ページの表示ラベル。 |
| name | string | Lightning ページの一意の名前。 |
| quickActionList | DescribeQuickActionListResult | 指定された Lightning ページに関連付けられたアクションのリスト。 |
| regions | DescribeFlexiPageRegion[] | 指定された Lightning ページの範囲のリスト。 |
| sobjectType | string |
FlexiPage が関連付けられているオブジェクト。種別が AppPage または HomePage の Lightning ページ では、この項目は null です。 この項目の値が設定されると、変更できなくなります。 API バージョン 33.0 以降で使用できます。 |
| template | string | 必須。FlexiPage が関連付けられているテンプレート。 この項目は、API バージョン 33.0 以降で使用できます。 |
| type | string | 必須。Lightning ページの種別。 有効な値は、次のとおりです。
API バージョン 32.0 以降で利用できます。 |
DescribeFlexiPageRegion
FlexiPage の範囲を表します。FlexiPage ごとに 1 つの範囲があります。範囲には、エンティティセットを範囲とすることができる、レコードリストコンポーネントまたは最近使ったデータコンポーネントを含めることができます。
| 名前 | 型 | 説明 |
|---|---|---|
| components | DescribeComponentInstance[] | 指定された Lightning ページのコンポーネントのリスト。 |
| name | string | FlexiPage 範囲の一意の名前。 |
DescribeComponentInstance
条件リストなどの、DescribeFlexiPageRegion のコンポーネントのインスタンスを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| properties | DescribeComponentInstanceProperty[] | コンポーネントインスタンスのプロパティ。 |
| typeName | string | コンポーネントの名前の最初の部分。たとえば、flexipage:filterListCard の「flexipage」。 |
| typeNamespace | string | コンポーネントの名前の 2 番目の部分。たとえば、flexipage:filterListCard の「filterListCard」。 |
DescribeComponentInstanceProperty
DescribeComponentInstance の単一プロパティを表します。
| 名前 | 型 | 説明 |
|---|---|---|
| name | string | コンポーネントインスタンスプロパティの名前。たとえば、filterListCard コンポーネントには「entityNames」という名前のプロパティがあります。 |
| region | DescribeFlexiPageRegion | 将来の使用のために予約されています。 この項目は、API バージョン 34.0 以降で使用できます。 |
| type | string | この項目値が null の場合、ComponentInstanceProperty の値が Lightning コンポーネントに適用されます。この項目値が decorator の場合、ComponentInstanceProperty の値が Lightning コンポーネントのコンポーネントデコレータに適用されます。 コンポーネントデコレータは、Lightning コンポーネントを囲むラッパーです。このデコレータでは、Lightning Experience に特定のページを表示するときに、追加の機能をコンポーネントに適用できます。たとえば、Lightning Experience ユーティリティバー上のコンポーネントを囲むコンポーネントデコレータを設定して、開いたときのコンポーネントの高さや幅を設定できます。UtilityBar は、コンポーネントデコレータをサポートする唯一のページ種別です。 有効な値は、次のとおりです。
|
| value | string | コンポーネントインスタンスプロパティの値。たとえば、filterListCard コンポーネントには entityNames プロパティがあり、この値は ["Account”, “Contact”, “Opportunity"] のようなカンマ区切りのエンティティ名のリストです。 |