`generateRecordInputForCreate(record,objectInfo)`

createRecord(RecordInput) を使用してレコードを作成するために使用できるレコードの表現 (レコード入力) を生成します。ObjectInfo を渡すと、レコード入力が作成可能な項目のみに絞り込まれます。

構文

1import { generateRecordInputForCreate } from 'lightning/uiRecordApi';
2generateRecordInputForCreate(record: Record, objectInfo?: ObjectInfo): RecordInput

パラメータ

record — (必須) ソースデータを含むレコードオブジェクト。レコードオブジェクトを作成するためのデータを取得するには、getRecordCreateDefaults または getRecord を使用します。
objectInfo — (省略可能) レコードの apiName に対応した ObjectInfo。指定した場合、createable=true である項目のみ (Id は除く) が応答に含められます。

戻り値

指定されたレコードからのデータが設定されたレコード入力オブジェクト。値がネストされたレコードではないすべての項目を返します。

使用方法

連絡先レコードのレコード入力オブジェクトを返します。

1import { LightningElement, api, wire } from "lwc";
2import { getRecordCreateDefaults, generateRecordInputForCreate } from "lightning/uiRecordApi";
3import CONTACT_OBJECT from "@salesforce/schema/Contact";
4
5export default class WireGenerateRecordInput extends LightningElement {
6  @wire(getRecordCreateDefaults, { objectApiName: CONTACT_OBJECT })
7  contactCreateDefaults;
8
9  get recordInputForCreate() {
10    if (!this.contactCreateDefaults.data) {
11      return undefined;
12    }
13
14    const contactObjectInfo =
15      this.contactCreateDefaults.data.objectInfos[CONTACT_OBJECT.objectApiName];
16    const recordDefaults = this.contactCreateDefaults.data.record;
17    const recordInput = generateRecordInputForCreate(recordDefaults, contactObjectInfo);
18    return recordInput;
19  }
20
21  get errors() {
22    return this.contactCreateDefaults.error;
23  }
24}

getRecordCreateDefaults からの値を使用して generateRecordInputForCreate をコールすると、連絡先レコードについて、次のようなオブジェクトが返されます。

1{
2  "apiName": "Contact",
3  "fields": {
4    "AccountId": null,
5    "AssistantName": null,
6    "AssistantPhone": null,
7    "Birthdate": null,
8    "Department": null,
9    "Description": null,
10    "Email": null,
11    "Fax": null,
12    "FirstName": null,
13    "HomePhone": null,
14    "LastName": null,
15    // More fields here
16  }
17}

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。