`refreshGraphQL(result)`

再実行するクエリをトリガーします。この関数は、GraphQL ワイヤアダプタがプロビジョニングしたデータを命令で更新します。

refreshGraphql() を使用すると、クエリを再実行する条件 (ボタンクリックの応答や JavaScript 経由など) を制御できます。この関数をコールすると、GraphQL クエリ要求がサーバに再度送信されて、クライアント側に保存されている結果セットが更新されます。

構文

1import { LightningElement, api, wire } from "lwc";
2import { gql, graphql, refreshGraphQL } from "lightning/uiGraphQLApi";
3
4export default class MyGQLQuery extends LightningElement {
5  @wire(graphql, {
6    query: gql`
7            query [your_graphql_query]`,
8  })
9  graphqlQueryResult(result) {
10    this.graphqlData = result; // Store the result so refreshGraphql() can refresh it later
11  }
12
13  // Trigger this function via a refresh button on the UI, or via javascript
14  @api
15  async refresh() {
16    return refreshGraphQL(this.graphqlData);
17  }
18}

GraphQL クエリの構文を参照してください。

戻り値

Promise オブジェクト。ワイヤが最新のデータを受け取るまで Promise は解決されません。サーバから返されたデータが変更されていない場合、ワイヤ関数は再度呼び出されない可能性があります。更新がいつ完了したかを知る必要がある場合は、Promise が解決されるのを待ちます。Promise が解決される実際の値には意味がありません。

詳細は、「Lightning Web コンポーネントでの GraphQL API の使用」を参照してください。

Tip

The Japanese Summer '24 guide is now live

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