SyncManager: register()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Die register()-Methode des SyncManager-Interfaces registriert ein Synchronisationsereignis, das ein sync-Ereignis innerhalb des zugehörigen Service Workers auslöst, sobald Netzwerkverbindung verfügbar ist.

Syntax

js
register(tag)

Parameter

tag

Ein Bezeichner für dieses Synchronisationsereignis. Dies wird der Wert der tag-Eigenschaft des SyncEvent sein, das an den sync-Ereignishandler des Service Workers übergeben wird.

Rückgabewert

Ein Promise, das sich zu undefined auflöst.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn der aktuelle Service Worker nicht aktiv ist.

NotAllowedError DOMException

Wird ausgelöst, wenn der Hintergrund-Sync vom Benutzer deaktiviert wurde.

Beispiele

Die folgende asynchrone Funktion registriert einen Hintergrund-Sync aus einem Browserkontext:

js
async function syncMessagesLater() {
  const registration = await navigator.serviceWorker.ready;
  try {
    await registration.sync.register("sync-messages");
  } catch {
    console.log("Background Sync could not be registered!");
  }
}

Spezifikationen

Specification
Web Background Synchronization
# dom-syncmanager-register

Browser-Kompatibilität

BCD tables only load in the browser