Web/API/PeriodicSyncManager/unregister

Draft This page is not complete.

The unregister() method of the PeriodicSyncManager interface unregisters the periodic sync request corresponding to the specified tag and returns a Promise that resolves when unregistration completes.

Syntax

var unregister = PeriodicSyncManager.unregister(tag);

Parameters

tag: The unique String descriptor for the specific background sync.

Return value

A resolved Promise.

Exceptions

None.

Examples

The following example removes a periodic sync to stop syncing articles in the background.

navigator.serviceWorker.ready.then(registration => {
  registration.periodicSync.unregister('get-latest-news');
});

Specifications

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

Browser compatibility

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
`unregister` 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.