PeriodicSyncManager.register()
Draft: This page is not complete.
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.
Syntax
var register = PeriodicSyncManager.register(tag, BackgroundSyncOptions);
Parameters
- tag
-
A unique
String
identifier - BackgroundSyncOptions Optional
-
An
Object
containing the following optional data:-
minInterval
: The minimum interval time, in milliseconds, at which the periodic sync should occur.
-
Return value
Returns a Promise
that resolves with undefined
Exceptions
- InvalidStateError
-
There is no active
ServiceWorker
present. - NotAllowedError
-
If permission for background periodic sync is not granted.
- InvalidAccessError
-
The active window is not the main window (not of "auxiliary" or "top-level" type).
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
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
register |
80 |
80 |
No |
No |
67 |
No |
80 |
80 |
No |
57 |
No |
13.0 |
See also
- Richer offline experiences with the Periodic Background Sync API
- A Periodic Background Sync demo app
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PeriodicSyncManager/register