chrome.alarms

Descrição

Permissões

Para usar a API chrome.alarms, declare a permissão "alarms" no manifesto:

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

Conceitos e uso

Para garantir um comportamento confiável, é útil entender como a API funciona.

Modo de espera do dispositivo

Os alarmes continuam tocando enquanto um dispositivo está em modo de espera. No entanto, um alarme não vai ativar um dispositivo. Quando o dispositivo for ativado, todos os alarmes perdidos serão disparados. Os alarmes recorrentes serão disparados no máximo uma vez e depois serão reagendados usando o período especificado a partir do momento em que o dispositivo é ativado, sem levar em consideração o tempo já decorrido desde que o alarme foi originalmente definido para ser executado.

Persistência

Os alarmes geralmente persistem até que uma extensão seja atualizada. No entanto, isso não é garantido, e os alarmes podem ser cancelados quando o navegador é reiniciado. Portanto, considere definir um valor no armazenamento quando um alarme for criado e verifique se ele existe sempre que o service worker for iniciado. Exemplo:

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

Exemplos

Os exemplos a seguir mostram como usar e responder a um alarme. Para testar essa API, instale o exemplo da API Alarm no repositório chrome-extension-samples (link em inglês).

Definir um alarme

O exemplo a seguir define um alarme no service worker quando a extensão é instalada:

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

Responder a um alarme

O exemplo a seguir define o ícone da barra de ferramentas de ação com base no nome do alarme que disparou.

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