PeriodicSyncEvent

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

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

ウェブ定期バックグラウンド同期 API の PeriodicSyncEvent インターフェイスは、ネットワーク接続がある状態でサービスワーカーでタスクを実行する方法を提供します。

このイベントのインスタンスが periodicsync ハンドラーに渡されます。これは、PeriodicSyncManager.register() メソッドで設定した以上の間隔で、定期的に行われます。実際の間隔は、ユーザーのサイトとのかかわりなど、その他の実装定義の要素によります。

Event ExtendableEvent PeriodicSyncEvent

コンストラクター

PeriodicSyncEvent()

新しい PeriodicSyncEvent オブジェクトを生成します。このコンストラクターは通常使用されません。ブラウザーがこれらのオブジェクトを作成し、onperiodicsync コールバックに渡します。

インスタンスプロパティ

親の ExtendableEvent からプロパティを継承します。

PeriodicSyncEvent.tag 読取専用

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

インスタンスメソッド

親の ExtendableEvent からメソッドを継承します。

例

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

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

fetchAndCacheLatestNews は開発者が定義した関数です。

仕様書

Specification
Web Periodic Background Synchronization
# periodicsync-event

ブラウザーの互換性

BCD tables only load in the browser

関連情報