API Периодической синхронизации фоновых данных веб-приложений

API Периодической синхронизации фоновых данных веб-приложений предоставляет способ регистрации задач, которые будут выполняться в service worker с периодическими интервалами при наличии сетевого подключения. Эти задачи называются запросами периодической фоновой синхронизации.

API Периодической фоновой синхронизации позволяет веб-приложениям уведомлять свой service worker о необходимости внесения обновлений в заданные временные интервалы. Это может включать в себя загрузку последнего контента, когда устройство подключено к Wi-Fi, или поддержку фоновых обновлений приложения.

Минимальный интервал времени устанавливается при вызове API; однако пользовательский агент также может учитывать другие факторы, влияющие на то, когда service worker получит событие. Например, предыдущая активность пользователя на сайте или подключение к известной сети.

Интерфейс PeriodicSyncManager доступен через ServiceWorkerRegistration.periodicSync. Уникальный идентификатор тега используется для «наименования» события синхронизации, которое затем можно прослушивать в скрипте ServiceWorker. После получения события можно выполнить любые необходимые действия, такие как обновление кэша или загрузка новых ресурсов.

Поскольку этот API опирается на service worker, функции, предоставляемые этим API, доступны только в защищённом контексте.

PeriodicSyncManager Экспериментальная

Регистрирует задачи, которые будут выполняться в service worker с периодическими интервалами при наличии сетевого подключения. Эти задачи называются запросами периодической фоновой синхронизации.

PeriodicSyncEvent Экспериментальная

Представляет собой событие синхронизации, отправляемое в глобальную область видимости глобальной области видимости ServiceWorker. Оно предоставляет способ выполнения задач в service worker с сетевым подключением.

Следующие дополнения к API Service Worker указаны в спецификации Периодической фоновой синхронизации, чтобы обеспечить точку входа для использования Периодической фоновой синхронизации.

ServiceWorkerRegistration.periodicSync Только для чтения Экспериментальная

Возвращает ссылку на интерфейс PeriodicSyncManager для регистрации задач, которые будут выполняться через заданные интервалы.

periodicsync событие Экспериментальная

Происходит через заданные интервалы, которые были указаны при регистрации PeriodicSyncManager.

Следующие примеры демонстрируют использование интерфейса.

Следующая асинхронная функция регистрирует периодическую фоновую синхронизацию с минимальным интервалом в один день из контекста просмотра:

async function registerPeriodicNewsCheck() {
  const registration = await navigator.serviceWorker.ready;
  try {
    await registration.periodicSync.register("get-latest-news", {
      minInterval: 24 * 60 * 60 * 1000,
    });
  } catch {
    console.log("Periodic Sync could not be registered!");
  }
}

Этот код проверяет, зарегистрирована ли задача Периодической фоновой синхронизации с заданным тегом.

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

Следующий код удаляет задачу Периодической фоновой синхронизации, чтобы остановить синхронизацию статей в фоновом режиме.

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

Следующий пример демонстрирует, как реагировать на событие периодической синхронизации в service worker.

self.addEventListener("periodicsync", (event) => {
  if (event.tag === "get-latest-news") {
    event.waitUntil(fetchAndCacheLatestNews());
  }
});

• Статья об использовании Периодической фоновой синхронизации
• Демо-приложение Периодической фоновой синхронизации