Periodic Background Sync
The register() method of the
PeriodicSyncManager interface registers a periodic sync request with the
browser with the specified tag and options. It returns a Promise that
resolves when the registration completes.
The method requires the periodic-background-sync permission; see the API's security considerations for details.
Syntax
register(tag, options)
Parameters
tag- : A unique String identifier.
options- : An Object containing the following optional data:
minInterval- : The minimum interval time, in milliseconds, at which the periodic sync should occur.
- : An Object containing the following optional data:
Return value
Returns a Promise that resolves with undefined.
Exceptions
InvalidStateErrorDOMException- : Thrown if there is no active ServiceWorker present.
NotAllowedErrorDOMException- : Thrown if the
periodic-background-syncpermission is not granted.
- : Thrown if the
InvalidAccessErrorDOMException- : Thrown if the active window is not the main window (not of
auxiliaryortop-leveltype).
- : Thrown if the active window is not the main window (not of
Examples
The following asynchronous function registers a periodic background sync at a minimum interval of one day from a browsing context:
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!");
}
}
Specifications
Browser compatibility
See also
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
