chrome.alarms

Description

Autorisations

Pour utiliser l'API chrome.alarms, déclarez l'autorisation "alarms" dans le fichier manifeste :

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

Concepts et utilisation

Pour garantir un comportement fiable, il est utile de comprendre le fonctionnement de l'API.

Veille de l'appareil

Les alarmes continuent de fonctionner lorsqu'un appareil est en veille. Toutefois, une alarme ne réveillera pas un appareil. Lorsque l'appareil se réactive, toutes les alarmes manquées se déclenchent. Les alarmes récurrentes se déclenchent au maximum une fois, puis sont reprogrammées en utilisant la période spécifiée à partir du moment où l'appareil se réveille, sans tenir compte du temps qui s'est déjà écoulé depuis que l'alarme a été initialement programmée.

Persistance

Les alarmes persistent généralement jusqu'à ce qu'une extension soit mise à jour. Toutefois, cela n'est pas garanti et les alarmes peuvent être effacées lorsque le navigateur est redémarré. Par conséquent, envisagez de définir une valeur dans le stockage lorsqu'une alarme est créée, puis assurez-vous qu'elle existe chaque fois que votre service worker démarre. Exemple :

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();

Exemples

Les exemples suivants montrent comment utiliser une alarme et y répondre. Pour essayer cette API, installez l'exemple d'API Alarm à partir du dépôt chrome-extension-samples.

Régler une alarme

L'exemple suivant définit une alarme dans le service worker lorsque l'extension est installée :

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
  });
});

Répondre à une alarme

L'exemple suivant définit l'icône de la barre d'action en fonction du nom de l'alarme qui s'est déclenchée.

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,
)