PeriodicSyncManager.getTags()

Draft

This page is not complete.

The getTags() method of the PeriodicSyncManager interface returns a Promise that resolves with a list of String objects representing the tags that are currently registered for periodic syncing.

Syntax

var tags = PeriodicSyncManager.getTags();

Parameters

None.

Return value

A Promise which resolves with a list of String objects representing tags that are currently registered for periodic syncing.

Exceptions

None.

Examples

The following example uses the getTags() method to check if a periodic sync task with a given tag is registered.

navigator.serviceWorker.ready.then(registration => {
  registration.periodicSync.getTags().then(tags => {
    if (tags.includes('get-latest-news'))
      skipDownloadingLatestNewsOnPageLoad();
  });
});

skipDownloadingLatestNewsOnPageLoad() is a developer defined function.

Specifications

Specification Status Comment
Web Periodic Background Synchronization
The definition of 'getTags' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also