getRecordNotifyChange(recordIds) (廃止)

非推奨。代わりに、notifyRecordUpdateAvailable(recordIds) を使用します。getRecordNotifyChange(recordIds) は、指定したレコード ID のレコード更新を取得し、Lightning Data Service キャッシュを更新することで、ワイヤアダプタに最新のレコードデータを供給します。getRecordNotifyChange(recordIds) は、同じ型のデータを返す複数のアダプタで使用するのに適していません。

getRecordNotifyChange(recordIds) は廃止されました。代わりに notifyRecordUpdateAvailable(recordIds) を使用することをお勧めします。

Note

構文 

1import { getRecordNotifyChange } from 'lightning/uiRecordApi';
2
3getRecordNotifyChange(items: Array<{recordId: string}>)

パラメータ 

  • items — (必須) オブジェクトの形状が { recordId: string } のオブジェクトの配列。レコード ID は 15 または 18 文字であり、サポートされるオブジェクトから取得する必要があります。

戻り値 

戻り値の型は void です。

使用方法 

Lightning データサービスのメカニズム外 (命令 Apex 経由や、サードパーティフレームワークを介したユーザインターフェース API のコールなど) でレコードが変更されたことを Lightning データサービスに通知するには、notifyRecordUpdateAvailable(recordIds) を使用します。

Note

getRecordNotifyChange(recordIds) をコールすると、指定された _recordID のデータ_が変更されていることが示されるため、必要に応じて Lightning データサービスキャッシュおよびワイヤを更新できます。

@wire を使用して Apex メソッドでレコードデータを取得する場合、@wire にバインドされている設定を使用してデータの取得とキャッシュの更新を行う、refreshApex() をコールします。

Note

関連トピック

The Japanese Summer '24 guide is now live

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