PeriodicSyncManager: register() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die register() Methode des PeriodicSyncManager-Interfaces registriert eine periodische Synchronisierungsanfrage mit dem Browser mit dem angegebenen Tag und Optionen. Sie gibt ein Promise zurück, das aufgelöst wird, wenn die Registrierung abgeschlossen ist.

Syntax

register(tag, options)

Parameter

tag

Eine eindeutige String-Kennung.

options Optional

Ein Object mit den folgenden optionalen Daten:

minInterval: Die minimale Intervallzeit in Millisekunden, in der die periodische Synchronisierung erfolgen soll.

Rückgabewert

Gibt ein Promise zurück, das mit undefined aufgelöst wird.

Ausnahmen

InvalidStateError DOMException: Wird zurückgegeben, wenn kein aktiver ServiceWorker vorhanden ist.
NotAllowedError DOMException: Wird zurückgegeben, wenn die Berechtigung für die periodische Hintergrundsynchronisierung nicht erteilt wurde.
InvalidAccessError DOMException: Wird zurückgegeben, wenn das aktive Fenster nicht das Hauptfenster ist (nicht vom Typ auxiliary oder top-level).

Beispiele

Die folgende asynchrone Funktion registriert eine periodische Hintergrundsynchronisierung mit einem Mindestintervall von einem Tag aus einem Browsing-Kontext:

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!");
  }
}

Spezifikationen

Specification
Web Periodic Background Synchronization # dom-periodicsyncmanager-register