PeriodicSyncManager: register() メソッド

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

register() は PeriodicSyncManager インターフェイスのメソッドで、 指定したタグとオプションでブラウザーに定期的な同期リクエストを登録します。登録が完了すると解決する Promise を返します。

構文

js
register(tag, options)

引数

tag

固有の文字列の識別子です。

options 省略可

以下のオプションデータを含む Object です。

minInterval

定期的な同期を行う最小間隔時間をミリ秒単位で指定します。

返値

undefined で解決する Promise を返します。

例外

InvalidStateError DOMException

アクティブなサービスワーカー (ServiceWorker) が存在しない場合に返されます。

NotAllowedError DOMException

バックグラウンド定期同期のその権限が与えられていない場合に返されます。

InvalidAccessError DOMException

アクティブウィンドウがメインウィンドウでない場合（auxiliary や top-level の種類でない場合）に返されます。

例

以下の非同期関数は、閲覧コンテキストから最小 1 日間隔で定期バックグラウンド同期を登録するものです。

js
async function registerPeriodicNewsCheck() {
  const registration = await navigator.serviceWorker.ready;
  try {
    await registration.periodicSync.register("fetch-news", {
      minInterval: 24 * 60 * 60 * 1000,
    });
  } catch {
    console.log("Periodic Sync could not be registered!");
  }
}

仕様書

Specification
Web Periodic Background Synchronization
# dom-periodicsyncmanager-register

ブラウザーの互換性

BCD tables only load in the browser

関連情報