ServiceWorkerGlobalScope: sync-Ereignis

Limited availability

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

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist nur in Service Workers verfügbar.

Das sync-Ereignis des ServiceWorkerGlobalScope-Interfaces wird ausgelöst, wenn die Seite (oder der Worker), die das Ereignis mit dem SyncManager registriert hat, ausgeführt wird, und sobald Netzwerkverbindung verfügbar ist.

Dieses Ereignis ist nicht stornierbar und wird nicht weitergeleitet.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignishandler-Eigenschaft.

addEventListener("sync", (event) => { })

onsync = (event) => { }

Ereignistyp

Ein SyncEvent. Erbt von ExtendableEvent und Event.

Ereigniseigenschaften

Erbt Eigenschaften von seinen Vorfahren, ExtendableEvent und Event.

SyncEvent.tag Schreibgeschützt: Gibt die vom Entwickler definierte Kennung für dieses SyncEvent zurück.
SyncEvent.lastChance Schreibgeschützt: Gibt true zurück, wenn der User-Agent keine weiteren Synchronisierungsversuche nach dem aktuellen Versuch unternehmen wird.

Beispiele

Das folgende Beispiel zeigt, wie man im Service Worker auf ein Sync-Ereignis reagiert.

self.addEventListener("sync", (event) => {
  if (event.tag === "sync-messages") {
    event.waitUntil(sendOutboxMessages());
  }
});

Sie können den Ereignishandler auch mit der onsync-Eigenschaft einrichten:

self.onsync = (event) => {
  // …
};

Spezifikationen

Specification
Web Background Synchronization # dom-serviceworkerglobalscope-onsync