Periodic Background Syncservice
The PeriodicSyncEvent interface of the Web Periodic Background Synchronization API provides a way to run tasks in the service worker with network connectivity.
An instance of this event is passed to the ServiceWorkerGlobalScope.periodicsync_event handler. This happens periodically, at an interval greater than or equal to that set in the PeriodicSyncManager.register() method. Other implementation-specific factors such as the user's engagement with the site decide the actual interval.
Constructor
- PeriodicSyncEvent.PeriodicSyncEvent
- : Creates a new
PeriodicSyncEventobject. This constructor is not typically used. The browser creates these objects itself and provides them to ServiceWorkerGlobalScope.periodicsync_event callback.
- : Creates a new
Instance properties
Inherits properties from its parent, ExtendableEvent.
- PeriodicSyncEvent.tag
- : Returns the developer-defined identifier for this
PeriodicSyncEvent. Multiple tags can be used by the web app to run different periodic tasks at different frequencies.
- : Returns the developer-defined identifier for this
Instance methods
Inherits methods from its parent, ExtendableEvent.
Examples
The following example shows how to respond to a periodic sync event in the service worker.
self.addEventListener("periodicsync", (event) => {
if (event.tag === "get-latest-news") {
event.waitUntil(fetchAndCacheLatestNews());
}
});
fetchAndCacheLatestNews is a developer defined function.
Specifications
Browser compatibility
See also
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
