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

Schema クラス

スキーマの Describe Information を取得するメソッドが含まれます。

名前空間

System

Schema のメソッド

Schema のメソッドは次のとおりです。すべてのメソッドが静的です。

getGlobalDescribe()

すべての sObject 名 (キー) の対応付けを、組織で定義された標準オブジェクトおよびカスタムオブジェクトの sObject トークン (値) に返します。

署名

public static Map<String, Schema.SObjectType> getGlobalDescribe()

戻り値

型: Map<String, Schema.SObjectType>

使用方法

sObject へのアクセスについての詳細は、「すべての sObject へのアクセス」を参照してください。

describeDataCategoryGroups(sObjectNames)

指定したオブジェクトに関連するカテゴリグループのリストを返します。

署名

public static List<Schema.DescribeDataCategoryGroupResult> describeDataCategoryGroups(List<String> sObjectNames)

パラメータ

sObjectNames
型: List<String>

戻り値

型: List<Schema.DescribeDataCategoryGroupResult>

使用方法

次の sObject 名のいずれかを指定できます。

  • KnowledgeArticleVersion — 記事タイプに関連するカテゴリグループを取得します。
  • Question — 質問に関連するカテゴリグループを取得します。

describeDataCategoryGroups の使用についての詳細およびコード例は、「sObject に関連付けられたすべてのデータカテゴリへのアクセス」を参照してください。

記事および質問についての詳細は、Salesforce オンラインヘルプの「記事および翻訳の操作」を参照してください。

describeSObjects(sObjectTypes)

指定された sObject または sObject の配列のメタデータ (項目リストとオブジェクトプロパティ) を表します。

署名

public static List<Schema.DescribeSObjectResult> describeSObjects(List<String> sObjectTypes)

パラメータ

sObjectTypes
型: List<String>
sObjectTypes 引数は、記述する sObject 型名のリストです。

使用方法

このメソッドは、Schema.sObjectType トークンの getDescribe メソッドと類似しています。getDescribe メソッドと異なり、このメソッドでは sObject 型を動的に指定して、複数の sObject を一度に記述できます。

最初に getGlobalDescribe をコールして組織のすべてのオブジェクトのリストを取得します。その後リスト内を反復処理し、describeSObjects を使用して個々のオブジェクトのメタデータを取得します。

describeSObjects(SObjectTypes, SObjectDescribeOptions)

指定された sObject の項目リストやオブジェクトプロパティなどのメタデータを表します。このメソッドのデフォルトの describe オプションは SObjectDescribeOptions.DEFERRED で、これは最初に使用するときに記述属性の遅延初期化を行うことを示します。

署名

public static List<Schema.DescribeSObjectResult> describeSObjects(List<String> SObjectTypes, Object SObjectDescribeOptions)

パラメータ

SObjectTypes
型: List<String>
記述する sObject 型のリスト。
SObjectDescribeOptions
型: Object
sObject で使用される有効な describe オプション。

戻り値

型: List<Schema.DescribeSObjectResult>

describeTabs()

実行ユーザが利用可能な標準アプリケーションとカスタムアプリケーションの情報を返します。

署名

public static List<Schema.DescribeTabSetResult> describeTabs()

使用方法

アプリケーションとは、タブのグループのことです。たとえば、標準 Salesforce アプリケーションとして「セールス」と「サービス」があります。

describeTabs メソッドは、アプリケーションを別のユーザインターフェースで表示するのに必要な最小限のメタデータを返します。通常このコールは、Salesforce データを別のユーザインターフェース (モバイルアプリケーションや接続アプリケーションなど) で表示するためにパートナーアプリケーションからコールされます。

Salesforce ユーザインターフェースでは、ページ上部の Salesforce アプリケーションメニューに示されているとおり、ユーザには標準的なアプリケーションへのアクセス権があります (カスタムアプリケーションへのアクセス権があることもあります)。メニューでアプリケーション名を選択すると、表示されるアプリケーションをいつでも切り替えることができます。

[すべてのタブ] タブは、前述のタブのリストには含まれません。

メモ

この例では、describeTabs メソッドをコールする方法を示します。

これは、Sales アプリケーションの Describe メタデータ情報を取得する方法を示す長めの例です。この例では、各タブのアイコンの URL、タブがカスタムであるかどうか、および色などについての Describe Information を取得します。Describe Information は、デバッグ出力に書き出されます。

GroupStructures(pairs)

要求で指定されたオブジェクトのデータカテゴリ構造と共に使用可能なカテゴリグループを返します。

署名

public static List<Schema.DescribeDataCategoryGroupStructureResult> describeDataCategory GroupStructures(List<Schema.DataCategoryGroupSobjectTypePair> pairs)

パラメータ

pairs
型: List<Schema.DataCategoryGroupSobjectTypePair>
pairs 引数は、Schema.DataCategoryGroupSobjectTypePairs を照会する 1 つ以上のカテゴリグループおよびオブジェクトです。指定されたオブジェクトの表示可能なデータカテゴリが取得されます。データカテゴリグループ表示設定についての詳細は、Salesforce オンラインヘルプの「データカテゴリの表示設定」を参照してください。