SyncManager.register()
Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
The SyncManager.register
method of the SyncManager
interface returns a Promise
that resolves to a SyncRegistration
instance.
Syntax
SyncManager.register([options]).then(function(syncRegistration) { ... })
Returns
A Promise
that resolves to an instance of SyncRegistration
.
Parameters
- options Optional
-
An object that sets options for an instance of
SyncRegistration
. The available options are:-
allowOnBattery
: A boolean that determines whether synchronization is allowed when the user agent is on a battery-powered device. The default istrue
. -
id
: The unique identifier of the specifiedSyncRegistration
object. -
idleRequired
: A boolean that determines whether synchronization is allowed when the user agent's device is idle. The default isfalse
. -
maxDelay
: The maximum delay in milliseconds before the nextsync
event (or the firstsync
event if it is periodic). The default is0
, meaning there is no maximum delay. -
minDelay
: The minimum delay in milliseconds before the nextsync
event (or the first sync event if it is periodic). The default is0
. -
minPeriod
: The minimum time in milliseconds between periodic sync events. The default is0
, meaning events are not periodic. -
minRequiredNetwork
: The network condition under which background synchronization will occur. Valid values are'network-any'
,'network-offline'
,'network-online'
,'network-non-mobile'
. The default value is'network-online'
.
-
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 |
49 |
79 |
No |
No |
No |
No |
49 |
49 |
No |
No |
No |
5.0 |
© 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/SyncManager/register