getRecordCreateDefaults

このワイヤアダプタを使用して、レコードの作成に必要なデフォルト情報とデータを取得します。

getRecordCreateDefaults は、このユーザインターフェース API リソースを使用します。

• objectApiName — (必須) サポートされているオブジェクト。

• formFactor — (省略可能) レコードのレイアウトの表示サイズ。次のいずれかの値を含む配列です。

  • Large — (デフォルト) この値を使用して、デスクトップ表示サイズのレイアウトを取得します。

  • Medium — この値を使用して、タブレット表示サイズのレイアウトを取得します。

  • Small — この値を使用して、電話表示サイズのレイアウトを取得します。

    formFactor として渡す値を取得するには、@salesforce/client/formFactor モジュールを使用します。

• recordTypeId — (省略可能) 新規レコードのレコードタイプ (RecordType オブジェクト) の ID。指定されていない場合は、デフォルトのレコードタイプが使用されます。.

• optionalFields — (省略可能) デフォルト項目とともに返される項目の配列。コンテキストユーザに省略可能項目へのアクセス権がある場合、その項目は応答に含まれます。コンテキストユーザに省略可能項目へのアクセス権がない場合、その項目は応答に含まれませんが、エラーも発生しません。

• propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。

• data — レコードのデフォルト値

応答では recordTypeInfo プロパティは使用しないでください。代わりに、すべてのレコードで返される recordTypeId プロパティを使用してください。

• error — FetchResponse

UI を作成してユーザがレコードを作成できるようにするには、最初に必須項目に関する情報を取得します。このアダプタの応答には、{apiName} で指定されたオブジェクト種別の新規レコードのデフォルト項目値が含まれます。また、オブジェクトメタデータと、作成モードに対応したレイアウトも含まれます。Salesforce ユーザインターフェースでは、「アプリケーションのカスタマイズ」権限を持つシステム管理者が、レイアウトの項目を必須としてマークできます。UI を構築する場合、レイアウトで作成または更新の必須項目を指定するには、ObjectInfo.fields[fieldName].required プロパティを使用します。

関連トピック

• ワイヤサービスについて
• Lightning データサービスでのエラーの処理
• lightning/ui*Api モジュールでサポートされている Salesforce オブジェクト