chrome.alarms

Descrição

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

Permissões

alarms

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

É possível controlar a persistência de um alarme no momento da criação usando a flag persistAcrossSessions. Pode ser definido como true (persiste até a atualização da extensão) ou false (é limpo se a extensão for recarregada ou o navegador for reiniciado, e sempre que a extensão for atualizada).

Outros navegadores e versões anteriores do Chrome

Essa propriedade não é compatível com outros navegadores (problema) nem com versões do Chrome anteriores à 150, em que o comportamento pode ser imprevisível. Portanto, é melhor garantir que os alarmes importantes existam sempre que o service worker for iniciado. Exemplo:

async function checkAlarmState() {
  const alarm = await chrome.alarms.get("my-alarm");

  if (!alarm) {
    await chrome.alarms.create("my-alarm", { periodInMinutes: 1 });
  }
}

checkAlarmState();

Se o alarme for criado dinamicamente com base na ação do usuário, talvez seja interessante armazenar que um alarme foi criado em outro lugar para que você saiba como recriá-lo, se necessário.

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.

Definir um alarme

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

service-worker.js:

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

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 optional

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

  • persistAcrossSessions

    booleano

    Pendente

    Indica se o alarme precisa persistir entre sessões (reinicializações do navegador).

  • scheduledTime

    número

    Horário em que o disparo do alarme foi programado, em milissegundos após a época (por exemplo, Date.now() + n). Por motivos de desempenho, o alarme pode ter sido adiado em uma quantidade arbitrária além disso.

AlarmCreateInfo

Propriedades

  • delayInMinutes

    número optional

    Período em minutos após o qual o evento onAlarm deve ser disparado.

  • periodInMinutes

    número optional

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

  • persistAcrossSessions

    booleano opcional

    Pendente

    Se o alarme deve persistir entre sessões (reinicializações do navegador). No Chrome, o padrão é "true" para corresponder ao comportamento histórico, mas você deve definir isso explicitamente para maximizar a compatibilidade entre navegadores.

  • quando

    número optional

    O momento em que o alarme deve disparar, em milissegundos após o período (por exemplo, Date.now() + n).

Métodos

clear()

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

Limpa o alarme com o nome especificado.

Parâmetros

  • nome

    string opcional

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

Retorna

  • Promise<boolean>

    Chrome 91 ou mais recente

clearAll()

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

Limpa todos os alarmes.

Retorna

  • Promise<boolean>

    Chrome 91 ou mais recente

create()

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

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 este.

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 um pouco mais. Ou seja, definir delayInMinutes ou periodInMinutes como menos de 0.5 não será aceito e vai causar um aviso. when pode ser definido como menos de 30 segundos após "agora" sem aviso, mas não vai disparar o alarme por pelo menos 30 segundos.

Para ajudar você a depurar seu app ou extensão, quando ele é carregado 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 o alarme. O padrão é uma 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 vai se repetir a cada periodInMinutes minutos após o evento inicial. Se nem when nem delayInMinutes estiverem definidos para um alarme recorrente, periodInMinutes será usado como padrão para delayInMinutes.

Retorna

  • Promessa<void>

    Chrome 111 ou mais recente

    Promessa que é resolvida quando o alarme é criado.

get()

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

Recupera detalhes sobre o alarme especificado.

Parâmetros

  • nome

    string opcional

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

Retorna

  • Promise<Alarm | undefined>

    Chrome 91 ou mais recente

getAll()

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

Recebe uma matriz de todos os alarmes.

Retorna

  • Promise<Alarm[]>

    Chrome 91 ou mais recente

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 esta aparência: 

    (alarm: Alarm) => void