DescribeLayoutResult

指定された sObjectType 固有のレイアウトを表します。各 DescribeLayout は一意なレイアウト ID を使用して参照し、2 つのタイプのビューが存在します (DescribeLayoutSection の配列としてこのオブジェクトで表されます)。

• 詳細ビュー — オブジェクトを参照のみの形式で表示します。詳細レイアウトでは、特定の情報 (詳細な住所など) を 1 つの DescribeLayoutItem にまとめることができます。
• 編集ビュー — オブジェクトを編集可能な形式で表示します。編集レイアウトでは、個々の情報 (住所など) はそれぞれの項目に分けられます。

個々の DescribeLayout には、次の項目があります。

標準ボタンまたはカスタムボタンのいずれかを含むレイアウトの 2 つのセクションのいずれかを表します。

DescribeLayout の単一の標準ボタン、カスタムボタン、またはカスタムリンクを表します。

レイアウトの最小単位である項目または境界を表します。表示するための項目の参照において、クライアントアプリケーションは次の表記法を使用し describeSObjects() コールの項目を参照します。LayoutComponent.fieldName

API バージョン 31.0 以降では、LayoutComponentType 値が Field で、記述される項目が Address または [Person Name] のいずれかの複合項目である場合、DescribeLayoutComponent は、FieldLayoutComponent によって拡張されます。

フィードの絞り込みに使用可能な個々のフィード条件オプションを表します。

フィードベースのページレイアウトのフィードビューのレイアウトを表します。

DescribeLayoutRow の個別のアイテムを表します。DescribeLayoutItem はコンポーネントセット (DescribeLayoutComponent) で構成され、それぞれは項目または境界です。レイアウトのほとんどの項目で、1 つのレイアウトアイテムごとにコンポーネントは 1 つだけです。ただし、表示のみのビューでは、DescribeLayoutItem は個別項目の組み合わせである場合があります (たとえば、住所は町名、市区郡、都道府県、国、郵便番号のデータから構成することができます)。対応する編集ビューでは、住所項目のそれぞれのコンポーネントは、別個の DescribeLayoutItem に分けられます。

DescribeLayoutSection の行を表します。DescribeLayoutRow は DescribeLayoutItem で構成されています。それぞれの DescribeLayoutRow について、DescribeLayoutItem は特定の項目または「空白の」DescribeLayoutItem ( DescribeLayoutComponent オブジェクトを含まない DescribeLayoutItem) を参照します。空の DescribeLayoutItem は、指定された DescribeLayoutRow がまばらである場合返されます (たとえば、左の列より右の列の方が項目が多い場合)。レイアウトに空白がある場合、空の DescribeLayoutItem がプレースホルダとして返されます。

DescribeLayout のセクションを表し、1 つ以上の列および 1 つ以上の行から構成されます (DescribeLayoutRow の配列)。

ページレイアウトに割り当てられたアクションのリストを表します。API バージョン 28.0 以降で利用できます。

ページレイアウトのアクションリストに割り当てられた QuickAction を表します。API バージョン 28.0 以降で利用できます。

LayoutComponentType の値が CustomLink の場合、この型にはページレイアウト上の 1 つのカスタムリンクに関する情報が含まれます。

DescribeLayoutComponent で返される情報を拡張します。LayoutComponentType の値が Field、記述される項目が Address または [Person Name] 項目の場合、FieldLayoutComponent には項目のコンポーネントに関する情報が含まれます。

API バージョン 31.0 以降で利用できます。

1DescribeLayoutComponent layoutComponent = layoutComponents[n];
2        // Look for a component representing the BillingAddress field
3        if (layoutComponent.getType() == LayoutComponentType.Field.toString() &&
4        layoutComponent.getValue().equals("BillingAddress") {
5        // Cast this component as a FieldLayoutComponent
6        DescribeLayoutComponent.FieldLayoutComponent addressFieldComponent =
7(FieldLayoutComponent)layoutComponent;
8        // At this point you can access addressFieldComponent
9FieldLayoutComponent-specific methods such as getComponents() or
10getFieldType()
11        }

RecordTypeMapping の単一のレコードタイプ選択リストを表します。picklistName は、describeSObjectResult の fields 配列の各項目の name 属性に一致します。picklistValues は、recordType の利用可能な値セットです。

DescribeLayoutResult オブジェクトの recordTypeMappings 項目の単一のレコードタイプの対応付けを表します。このオブジェクトは、有効な recordTypeIds の layoutId に対する対応付けです。詳細ビューを表示するために、クライアントアプリケーションはこの対応付けを使用して、レコードのレコードタイプに関連付けられたレイアウトを確認します。編集ビューを表示するために、クライアントアプリケーションはこの対応付けを使用して使用するレイアウトを確認します (また、ユーザによる複数のレコードタイプの選択を許可します)。また、利用可能な選択リストの値セットも確認します。

DescribeLayout のモバイルカードセクションを表します。API バージョン 29.0 以降で利用できます。

DescribeLayoutResult の単一の関連リストを表します。

DescribeLayoutResult が返した関連リストの単一項目を表します。

関連リストのオブジェクトの並び替え設定を表します。

1ORDER BY relatedListSort[0].getColumn() DIRECTION, relatedListSort[1].getColumn() DIRECTION