PeriodicSyncManager: register()-Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Die register()-Methode der PeriodicSyncManager-Schnittstelle registriert eine periodische Sync-Anforderung mit dem Browser unter Verwendung des angegebenen Tags und der Optionen. Sie gibt ein Promise zurück, das gelöst wird, wenn die Registrierung abgeschlossen ist.

Syntax

js
register(tag, options)

Parameter

tag

Ein eindeutiger String-Bezeichner.

options Optional

Ein Object mit den folgenden optionalen Daten:

minInterval

Die minimale Intervallzeit in Millisekunden, in der der periodische Sync erfolgen soll.

Rückgabewert

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

Ausnahmen

InvalidStateError DOMException

Wird zurückgegeben, wenn kein aktiver ServiceWorker vorhanden ist.

NotAllowedError DOMException

Wird zurückgegeben, wenn keine Erlaubnis für den periodischen Hintergrund-Sync 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 einen periodischen Hintergrund-Sync in einem Mindestintervall von einem Tag aus einem Browsing-Kontext:

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

Spezifikationen

Specification
Web Periodic Background Synchronization
# dom-periodicsyncmanager-register

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch