ServiceWorkerGlobalScope: periodicsync イベント

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

メモ: この機能はサービスワーカー内でのみ利用可能です。

periodicsync は ServiceWorkerGlobalScope インターフェイスのイベントで、 PeriodicSyncManagerを登録したときに指定された時間間隔で発行されます。

このイベントはキャンセル不可で、バブリングしません。

構文

このイベント名を addEventListener() 等のメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

js
addEventListener("periodicsync", (event) => {});

onperiodicsync = (event) => {};

イベント型

PeriodicSyncEvent です。 Event を継承しています。

Event ExtendableEvent PeriodicSyncEvent

イベントプロパティ

祖先である Event からプロパティを継承しています。

PeriodicSyncEvent.tag 読取専用

この PeriodicSyncEvent の開発者定義の識別子を返します。ウェブアプリケーションで複数のタグを使用すると、異なる頻度で異なる定期的なタスクを実行することができます。

例

以下の例は、サービスワーカーで定期的な同期イベントに応答する方法を示しています。

js
self.addEventListener("periodicsync", (event) => {
  if (event.tag === "get-latest-news") {
    event.waitUntil(fetchAndCacheLatestNews());
  }
});

また、 onperiodicsync プロパティを使用してイベントハンドラーを設定することもできます。

js
self.onperiodicsync = (event) => {
  // ...
};

仕様書

Specification
Web Periodic Background Synchronization
# periodicsync-event
Web Periodic Background Synchronization
# dom-serviceworkerglobalscope-onperiodicsync

ブラウザーの互換性

BCD tables only load in the browser

関連情報