chrome.alarms

Descrição

Use a API chrome.alarms para programar a execução periódica do código ou em um horário especificado no futuro.

Permissões

alarms

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

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

Conceitos e uso

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

Suspensão do dispositivo

Os alarmes continuam sendo executados enquanto o dispositivo está em modo de suspensão. No entanto, um alarme não ativa um dispositivo. Quando o dispositivo for ativado, os alarmes perdidos serão disparados. Os alarmes recorrentes são acionados no máximo uma vez e depois reprogramados usando o período especificado a partir do momento em que o dispositivo é ativado, sem levar em conta o tempo que já passou 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 limpos quando o navegador é reiniciado. Consequentemente, defina 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 do repositório chrome-extension-samples.

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

Tipos

Alarm

Propriedades

  • nome

    string

    Nome do alarme.

  • periodInMinutes

    número opcional

    Se não for nulo, o alarme será recorrente e será disparado novamente em periodInMinutes minutos.

  • scheduledTime

    number

    Hora em que o alarme foi programado para ser acionado, em milissegundos após a época (por exemplo, Date.now() + n). Por motivos de desempenho, o alarme pode ter sido adiado por um período arbitrário.

AlarmCreateInfo

Propriedades

  • delayInMinutes

    número opcional

    Tempo em minutos após o qual o evento onAlarm precisa ser acionado.

  • periodInMinutes

    número opcional

    Se definido, o evento onAlarm será acionado a cada periodInMinutes minutos após o evento inicial especificado por when ou delayInMinutes. Se não for definido, o alarme só será acionado uma vez.

  • quando

    número opcional

    O momento em que o alarme precisa ser acionado, em milissegundos após a época (por exemplo, Date.now() + n).

Métodos

clear()

Promessa 
chrome.alarms.clear(
  name?: string,
  callback?: function,
)

Limpa o alarme com o nome indicado.

Parâmetros

  • nome

    string opcional

    O nome do alarme a ser limpo. O padrão é a string vazia.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (wasCleared: boolean) => void

    • wasCleared

      booleano

Retorna

  • Promise<boolean>

    Chrome 91 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

clearAll()

Promessa 
chrome.alarms.clearAll(
  callback?: function,
)

Limpa todos os alarmes.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (wasCleared: boolean) => void

    • wasCleared

      booleano

Retorna

  • Promise<boolean>

    Chrome 91 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

create()

Promessa 
chrome.alarms.create(
  name?: string,
  alarmInfo: AlarmCreateInfo,
  callback?: function,
)

Cria um alarme. Perto dos horários especificados por alarmInfo, o evento onAlarm é acionado. Se houver outro alarme com o mesmo nome (ou sem nome, se nenhum for especificado), ele será cancelado e substituído por esse alarme.

Para reduzir a carga na máquina do usuário, o Chrome limita os alarmes a, no máximo, uma vez a cada 30 segundos, mas pode atrasá-los por um período arbitrário. Ou seja, definir delayInMinutes ou periodInMinutes como menor que 0.5 não será aceito e vai gerar um aviso. O when pode ser definido para menos de 30 segundos após "agora" sem aviso, mas não vai acionar o alarme por pelo menos 30 segundos.

Para ajudar a depurar seu app ou extensão, quando você o carrega descompactado, não há limite para a frequência com que o alarme pode ser acionado.

Parâmetros

  • nome

    string opcional

    Nome opcional para identificar esse alarme. O padrão é a string vazia.

  • alarmInfo

    AlarmCreateInfo

    Descreve quando o alarme deve ser acionado. O horário inicial precisa ser especificado por when ou delayInMinutes (mas não ambos). Se periodInMinutes estiver definido, o alarme será repetido a cada periodInMinutes minutos após o evento inicial. Se when ou delayInMinutes não estiverem definidos para um alarme recorrente, periodInMinutes será usado como padrão para delayInMinutes.

  • callback

    função opcional

    Chrome 111 e versões mais recentes

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 111 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

get()

Promessa 
chrome.alarms.get(
  name?: string,
  callback?: function,
)

Recupera detalhes sobre o alarme especificado.

Parâmetros

  • nome

    string opcional

    O nome do alarme a ser recebido. O padrão é a string vazia.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (alarm?: Alarm) => void

Retorna

  • Promise<Alarm | undefined>

    Chrome 91 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

getAll()

Promessa 
chrome.alarms.getAll(
  callback?: function,
)

Recebe uma matriz de todos os alarmes.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (alarms: Alarm[]) => void

Retorna

  • Promise<Alarm[]>

    Chrome 91 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

Eventos

onAlarm

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

Disparado quando um alarme expira. Útil para páginas de eventos.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (alarm: Alarm) => void