getRecordUi (廃止)
非推奨。このワイヤアダプタは、レイアウト情報、メタデータ、およびデータを取得して、1 つ以上のレコードの UI を作成します。
レコードを操作するための UI を作成するには、代わりに lightning-record-form、lightning-record-edit-form、および lightning-record-view-form 基本コンポーネントを使用します。代替ワイヤアダプタを使用したレイアウトの取得は現在サポートされていません。詳細は、**「使用方法」**セクションを参照してください。
getRecordUi は廃止される機能であり、今後は更新されず、Salesforce とのマスターサブスクリプション契約における「サービス」には含まれません。この機能はお客様各自の裁量で使用し、購入するときは、現在正式にリリースされている製品および機能に基づいて判断してください。Salesforce はこの機能の特定期間内の正式リリースまたはリリースの有無を保証しません。また、いかなる時点でもこの機能を終了できるものとします。getRecordUi は評価のみを目的とし、本番環境での使用はできません。この機能は、そのままの状態で提供され、サポートされておらず、ここから生じる、またはこれに関連する被害または損害に対して、Salesforce はいかなる責任も負いません。すべての制約、Salesforce の権利の保留、本サービスに関する義務、および関連する Salesforce 以外のアプリケーションならびにコンテンツの条件は、この機能の使用に等しく適用されます。
構文
1import { LightningElement, wire } from 'lwc';
2import { getRecordUi } from 'lightning/uiRecordApi';
3
4export default class Example extends LightningElement {
5 @wire(getRecordUi, { recordIds: string|string[], layoutTypes: string|string[],
6 modes: string|string[], optionalFields?: string|string[] })
7 propertyOrFunction;
8}
ユーザインターフェース API リソース
1GET /ui-api/record-ui/{recordsIds}
getRecordUi ワイヤアダプタでは、このユーザインターフェース API リソースが使用されますが、そのすべてのパラメータはサポートされません。
パラメータ
recordIds — (必須) 読み込むレコードの ID。文字列または文字列の配列。すべてのレコード ID はサポートされているオブジェクトから取得する必要があります。layoutTypes — (必須) レコードのレイアウト種別。文字列または文字列の配列。各文字列は、次のいずれかの値となります。
Compact — この値を使用して、レコードの重要な項目が含まれるレイアウトを取得します。Full — この値を使用して、フルレイアウトを取得します。
modes — (必須) レコードのアクセスモード。この値によって、レイアウトから取得する項目が決まります。レイアウトには作成、編集、表示の各モードで異なる項目が含まれます。たとえば、数式項目は表示モードで表示しますが作成モードでは表示しません。この項目はスプレッドシートの数式など、実行時に計算されるためです。
文字列または文字列の配列。各文字列には、次のいずれかの値が含まれます。
-
Create — レコードをユーザが作成できる UI の構築を目的とする場合、このモードを使用します。
-
Edit — レコードをユーザが編集できる UI の構築を目的とする場合、このモードを使用します。
-
View — レコードを表示する UI の構築を目的とする場合、このモードを使用します。
-
optionalFields — (省略可能) 省略可能項目名または省略可能項目名の配列。コンテキストユーザに項目へのアクセス権がある場合、その項目は応答に含まれます。コンテキストユーザに項目へのアクセス権がない場合、その項目は応答に含まれませんが、エラーも発生しません。
-
propertyOrFunction — ワイヤサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティと error プロパティを持つオブジェクトで返されます。
戻り値
応答では recordTypeInfo プロパティは使用しないでください。代わりに、すべてのレコードで返される recordTypeId プロパティを使用してください。
使用方法
getRecordUi は廃止されました。代わりに、lightning-record-form、lightning-record-edit-form、および lightning-record-view-form 基本コンポーネントを使用することをお勧めします。
レイアウトを取得するには、これらのワイヤアダプタのいずれかを使用して、特定の項目や省略可能な項目を要求することを検討してください。
関連トピック
j