chrome.alarms

Opis

Uprawnienia

Aby używać interfejsu chrome.alarms API, zadeklaruj uprawnienie "alarms" w pliku manifestu:

{   "name": "My extension",   ...   "permissions": [     "alarms"   ],   ... } 

Pojęcia i zastosowanie

Aby zapewnić niezawodne działanie, warto zrozumieć, jak działa interfejs API.

Uśpienie urządzenia

Alarmy działają nadal, gdy urządzenie jest uśpione. Alarm nie wybudzi jednak urządzenia. Gdy urządzenie się wybudzi, uruchomią się wszystkie alarmy, które zostały pominięte. Powtarzające się alarmy włączają się co najwyżej raz, a potem są ponownie planowane z użyciem określonego okresu, począwszy od momentu, w którym urządzenie się włączy, bez uwzględniania czasu, który upłynął od momentu, w którym alarm miał się pierwotnie włączyć.

Trwałość

Alerty zwykle utrzymują się do momentu zaktualizowania rozszerzenia. Nie jest to jednak gwarantowane, a alarmy mogą zostać wyczyszczone po ponownym uruchomieniu przeglądarki. Dlatego podczas tworzenia alarmu warto ustawić wartość w pamięci, a potem upewnić się, że istnieje ona za każdym razem, gdy uruchamia się skrypt service worker. Na przykład:

const STORAGE_KEY = "user-preference-alarm-enabled";  async function checkAlarmState() {   const { alarmEnabled } = await chrome.storage.get(STORAGE_KEY);    if (alarmEnabled) {     const alarm = await chrome.alarms.get("my-alarm");      if (!alarm) {       await chrome.alarms.create({ periodInMinutes: 1 });     }   } }  checkAlarmState(); 

Przykłady

Poniższe przykłady pokazują, jak używać alarmu i na niego reagować. Aby wypróbować ten interfejs API, zainstaluj przykład interfejsu Alarm API z repozytorium chrome-extension-samples.

Ustaw alarm

W tym przykładzie alarm jest ustawiany w procesie service worker po zainstalowaniu rozszerzenia:

service-worker.js:

chrome.runtime.onInstalled.addListener(async ({ reason }) => {   if (reason !== 'install') {     return;   }    // Create an alarm so we have something to look at in the demo   await chrome.alarms.create('demo-default-alarm', {     delayInMinutes: 1,     periodInMinutes: 1   }); }); 

Reagowanie na alarm

W tym przykładzie ikona paska narzędzi działania jest ustawiana na podstawie nazwy alarmu, który się włączył.

service-worker.js:

chrome.alarms.onAlarm.addListener((alarm) => {   chrome.action.setIcon({     path: getIconPath(alarm.name),   }); }); 

chrome.alarms.clear(
  name?: string,
): Promise<boolean>

chrome.alarms.clearAll(): Promise<boolean>

chrome.alarms.create(
  name?: string,
  alarmInfo: AlarmCreateInfo,
): Promise<void>

chrome.alarms.get(
  name?: string,
): Promise<Alarm | undefined>

chrome.alarms.getAll(): Promise<Alarm[]>

chrome.alarms.onAlarm.addListener(
  callback: function,
)