PeriodicSyncRegistration

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 PeriodicSyncRegistration interface of the ServiceWorker API provides an object for managing periodic background synchronization.

Properties

PeriodicSyncRegistration.minPeriodRead only
Provides in miliseconds the minimum time between periodic sync events. User agents may delay this event for reasons ranging from usage frequency to device states such as, for example, battery charge, connectivity, and location.
PeriodicSyncRegistration.networkStateRead only
Indicates the network condition under which periodic background synchronization will occur. Valid values are 'any', 'avoid-cellular', and 'online'.
PeriodicSyncRegistration.powerState Read only
Indicates how the PeriodicSyncRegistration deals with a devices' battery conditions. Valid values are 'auto', and 'avoid-draining'.
PeriodicSyncRegistration.tagRead only
Provides the unique identifier of the specified PeriodicSyncRegistration.

Methods

PeriodicSyncRegistration.unregister
Returns a Promise that resolves to Boolean indicating whether the PeriodicSyncRegistration object was unregistered.

Examples

// TBD

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support ? ? ? ?
Feature Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support ? ? ? ? ? No support

Document Tags and Contributors

 Contributors to this page: rolfedh, jpmedley
 Last updated by: rolfedh,