Web/API/PeriodicSyncEvent/PeriodicSyncEvent

Draft This page is not complete.

The PeriodicSyncEvent() constructor creates a new PeriodicSyncEvent object. This constructor is not typically used. The browser creates these objects itself and provides them to ServiceWorkerGlobalScope.onperiodicsync callback.

Syntax

var PeriodicSyncEvent = new PeriodicSyncEvent();

Parameters

type

A DOMString indicating the event which occurred. For PeriodicSyncEvent, this is always periodicsync.

periodicSyncEventInitDict Optional

An options object containing any initialization data you want to populate the PeriodicSyncEvent object with. The options are:

tag

• The tag referencing the sync event.

Return value

A PeriodicSyncEvent object configured using the given inputs.

Examples

This example constructs a new PeriodicSyncEvent with the relevant associated tag.

var syncTag = {
  tag : 'unique-tag'
}

var psEvent = new ExtendableEvent('periodicsync', syncTag);

psEvent.tag; // should return 'unique-tag'

Specifications

Specification	Status	Comment
Web Periodic Background SynchronizationThe definition of 'PeriodicSyncEvent' in that specification.	Working Draft	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PeriodicSyncEvent() constructor Experimental'Non-standard'	Chrome Full support 80	Edge Full support 80	Firefox No support No	IE No support No	Opera Full support 67	Safari No support No	WebView Android Full support 80	Chrome Android Full support 80	Firefox Android No support No	Opera Android Full support 57	Safari iOS No support No	Samsung Internet Android Full support 13.0

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Non-standard. Expect poor cross-browser support.'

Non-standard. Expect poor cross-browser support.

See also

• Richer offline experiences with the Periodic Background Sync API
• A Periodic Background Sync demo app

PeriodicSyncEvent() by Mozilla Contributors is licensed under CC-BY-SA 2.5.