DescribeLayoutResult

DescribeLayout

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

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

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

DescribeLayoutButtonSection

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

DescribeLayoutButton

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

DescribeLayoutComponent

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

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

DescribeLayoutFeedFilter

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

DescribeLayoutFeedView

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

DescribeLayoutItem

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

DescribeLayoutRow

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

DescribeLayoutSection

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

DescribeQuickActionListResult

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

DescribeQuickActionListItemResult

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

CustomLinkComponent

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

FieldLayoutComponent

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

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

FieldLayoutComponent の使用方法を示すサンプルコード

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        }

LayoutComponentType

DescribeLayoutComponent のタイプを表します。次の値の 1 つを含みます。

• AnalyticsCloud — ページレイアウトの CRM Analytics ダッシュボード。API バージョン 34.0 以降で利用できます。
• Canvas — ページレイアウトのキャンバスコンポーネント。このレイアウトコンポーネントの種類は、API バージョン 31.0 以降で使用できます。
• CustomLink — ページレイアウトのカスタムリンク。
• EmptySpace — ページレイアウトの空白スペース。
• ExpandedLookup — ページレイアウトのモバイルカードセクションにある拡張ルックアップコンポーネント。
• Field — 項目名。describeSObjectResult の RecordTypeInfo 項目への対応付け。
• ReportChart — ページレイアウトのレポートグラフ。
• SControl — 今後の使用のための予約。
• Separator — セミコロン (:) やスラッシュ (/) などの区切り文字。
• VisualforcePage — ページレイアウトの Visualforce コンポーネント。

PicklistForRecordType

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

RecordTypeMapping

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

RelatedContent

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

DescribeRelatedContentItem

DescribeRelatedContentItem リスト内の個々の項目を表します。API バージョン 29.0 以降で使用できます。

RelatedList

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

RelatedListColumn

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

RelatedListSort

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

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

DescribeLayoutSaveOption

レイアウトの保存オプションを表します。保存オプションでは、特定のレイアウトを使用してオブジェクトが作成または変更されたときに実行する動作を定義します。たとえば、ケースとリードの場合、「UseDefaultAssignmentRule」保存オプションが表示されます。これにより、ケースまたはリードが作成または編集されたときに割り当てルールを適用するかどうかを制御します。

WebLinkPosition

DescribeLayoutButton をクリックすると開く新規ウィンドウのウィンドウ位置を表します。カスタムボタンにのみ適用されます。API バージョン 31.0 以降で利用できます。次のいずれかの値が含まれます。

• fullScreen — 全画面で新しいウィンドウが開きます。このオプションを選択すると、新しいウィンドウに設定された幅または高さのパラメーターは無視されます。
• none — ウィンドウの位置が設定されていません。
• topLeft — 画面の左上で新しいウィンドウが開きます。

WebLinkType

カスタムボタンが配信するコンテンツを表します。次のいずれかの値が含まれます。

• javascript
• page — Visualforce ページ
• sControl
• url

WebLinkWindowType

DescribeLayoutButton の動作を表します。カスタムボタンにのみ適用されます。API バージョン 31.0 以降で利用できます。次のいずれかの値が含まれます。

• newWindow — カスタムボタンのコンテンツが新しいブラウザーウィンドウに開きます。
• noSidebar — カスタムボタンのコンテンツがサイドバーのない既存のブラウザーウィンドウに表示されます。
• onClickJavaScript — DescribeLayoutButton の contentSource 項目値が javascript の場合にのみ有効です。ボタンまたはリンクをクリックすると、JavaScript が実行されます。
• replace — カスタムボタンのコンテンツがサイドバーやヘッダーのない既存のブラウザーウィンドウに表示されます。
• sidebar — カスタムボタンのコンテンツがサイドバーのある既存のブラウザーウィンドウに表示されます。