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
Web Periodic Background Synchronization
# dom-periodicsyncmanager-unregister

Browser compatibility

BCD tables only load in the browser

See also