`unregisterRefreshHandler()`

コンポーネントの更新ハンドラメソッドを更新処理から削除します。

構文

1import { LightningElement, wire } from "lwc";
2import { unregisterRefreshHandler } from "lightning/refresh";
3
4export function unregisterRefreshHandler(refreshID);

パラメータ

refreshID — (必須) 更新ツリーでこのコンポーネントのノードを一意に識別するための数値の refreshNode.handle 値を返します。registerRefreshHandler() をコールすると、refreshNode.handle 値を取得できます。

戻り値

なし。

使用方法

unregisterRefreshHandler() メソッドは、更新ツリーから更新ハンドラの登録を削除するために使用します。子コンテキストは、更新の途中で登録が解除された場合のために、確実に更新が行われるように一時的に保持されます。

disconnectedCallback() で、コンポーネントのハンドラコールバックメソッドの登録を解除する必要があります。

1import { unregisterRefreshHandler } from 'lightning/refresh';
2
3disconnectedCallback() {
4  unregisterRefreshHandler(this.refreshHandlerID);
5}

The Japanese Summer '24 guide is now live

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