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: Dieses Feature ist nur verfügbar in Service Workers.

Das sync Ereignis des ServiceWorkerGlobalScope Interface wird ausgelöst, wenn die Seite (oder der Worker), die das Ereignis mit dem SyncManager registriert hat, läuft und sobald die Netzwerkkonnektivität verfügbar ist.

Dieses Ereignis kann nicht abgebrochen werden und wird nicht ausgelöst.

Syntax

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

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

onsync = (event) => {};

Ereignistyp

Ein SyncEvent. Erbt von ExtendableEvent und Event.

Event ExtendableEvent SyncEvent

Ereigniseigenschaften

Erbt Eigenschaften von seinem Vorfahren, ExtendableEvent und Event.

SyncEvent.tag Nur lesbar

Gibt den entwicklerdefinierten Bezeichner für dieses SyncEvent zurück.

SyncEvent.lastChance Nur lesbar

Gibt true zurück, wenn der Benutzer-Agent nach dem aktuellen Versuch keine weiteren Synchronisierungsversuche unternehmen wird.

Beispiele

Das folgende Beispiel zeigt, wie auf ein sync Ereignis im Service Worker reagiert wird.

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

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

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

Spezifikationen

Specification
Web Background Synchronization
# dom-serviceworkerglobalscope-onsync

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch