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.
PeriodicSyncManager.register()
Syntax
var register = PeriodicSyncManager.register(tag, BackgroundSyncOptions);
Parameters
Return value
Exceptions
-
InvalidStateError
DOMException
-
Returned if there is no active
ServiceWorker
present. -
NotAllowedError
DOMException
-
Returned if permission for background periodic sync is not granted.
-
InvalidAccessError
DOMException
-
Returned if the active window is not the main window (not of
auxiliary
ortop-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
© 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