browser.alarms

Descripción

Usa la API de chrome.alarms para programar la ejecución de código de forma periódica o en un momento específico en el futuro.

Permisos

alarms

Para usar la API de browser.alarms, declara el permiso "alarms" en el manifiesto:

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

Conceptos y uso

Para garantizar un comportamiento confiable, es útil comprender cómo se comporta la API.

Suspensión del dispositivo

Las alarmas se siguen ejecutando mientras el dispositivo está en modo de suspensión. Sin embargo, una alarma no activará un dispositivo. Cuando el dispositivo se active, se activarán las alarmas perdidas. Las alarmas repetitivas se activarán, como máximo, una vez y, luego, se reprogramarán con el período especificado a partir del momento en que se active el dispositivo, sin tener en cuenta el tiempo que ya haya transcurrido desde que se configuró originalmente la alarma para que se ejecute.

Persistencia

Puedes controlar la persistencia de una alarma en el momento de su creación con la marca persistAcrossSessions. Se puede establecer en true (persiste hasta que se actualiza la extensión) o false (se borra si se vuelve a cargar la extensión o se reinicia el navegador, y cada vez que se actualiza la extensión).

Otros navegadores y versiones anteriores de Chrome

Esta propiedad no es compatible con otros navegadores (problema) ni con versiones de Chrome anteriores a Chrome 150, en las que el comportamiento puede ser impredecible. Por lo tanto, lo mejor es asegurarse de que existan alarmas importantes cada vez que se inicie el service worker. Por ejemplo:

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

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

checkAlarmState();

Si tu alarma se crea de forma dinámica según la acción del usuario, te recomendamos que almacenes la información de que se creó una alarma en otro lugar para que sepas que debes volver a crearla si es necesario.

Ejemplos

En los siguientes ejemplos, se muestra cómo usar una alarma y responder a ella. Para probar esta API, instala el ejemplo de la API de Alarm desde el repositorio chrome-extension-samples.

Cómo establecer una alarma

En el siguiente ejemplo, se configura una alarma en el service worker cuando se instala una versión nueva de la extensión:

service-worker.js:

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

Cómo responder a una alarma

En el siguiente ejemplo, se establece el ícono de la barra de herramientas de acciones según el nombre de la alarma que se activó.

service-worker.js:

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

Tipos

Alarm

Propiedades

  • nombre

    string

    Es el nombre de esta alarma.

  • periodInMinutes

    number opcional

    Si no es nulo, la alarma es recurrente y volverá a sonar en periodInMinutes minutos.

  • persistAcrossSessions

    booleano

    Chrome 150 o versiones posteriores

    Indica si la alarma debe persistir entre sesiones (reinicios del navegador).

  • scheduledTime

    número

    Es la hora en la que se programó la activación de esta alarma, en milisegundos transcurridos desde el tiempo de referencia (p.ej., Date.now() + n). Por motivos de rendimiento, es posible que la alarma se haya retrasado una cantidad arbitraria más allá de este valor.

AlarmCreateInfo

Propiedades

  • delayInMinutes

    number opcional

    Es el período, en minutos, después del cual se debe activar el evento onAlarm.

  • nombre

    string opcional

    Chrome 152 y versiones posteriores

    Es el nombre de esta alarma.

  • periodInMinutes

    number opcional

    Si se establece, el evento onAlarm debería activarse cada periodInMinutes minutos después del evento inicial especificado por when o delayInMinutes. Si no se establece, la alarma solo se activará una vez.

  • persistAcrossSessions

    booleano opcional

    Chrome 150 o versiones posteriores

    Indica si la alarma debe persistir entre sesiones (reinicios del navegador). En Chrome, el valor predeterminado es verdadero para que coincida con el comportamiento histórico, pero debes establecerlo de forma explícita para maximizar la compatibilidad entre navegadores.

  • cuándo

    number opcional

    Es la hora en la que se debe activar la alarma, en milisegundos después de la época (p.ej., Date.now() + n).

Métodos

clear()

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

Borra la alarma con el nombre determinado.

Parámetros

  • nombre

    string opcional

    Es el nombre de la alarma que se borrará. La configuración predeterminada es la cadena vacía.

Muestra

  • Promise<boolean>

    Chrome 91 y versiones posteriores

clearAll()

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

Borra todas las alarmas.

Muestra

  • Promise<boolean | undefined>

    Chrome 91 y versiones posteriores

create()

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

Crea una alarma. Cerca de las horas especificadas por alarmInfo, se activa el evento onAlarm. Si hay otra alarma con el mismo nombre (o sin nombre, si no se especifica ninguno), se cancelará y se reemplazará por esta alarma.

Para reducir la carga en la máquina del usuario, Chrome limita las alarmas a una vez por segundo como máximo, pero puede retrasarlas una cantidad arbitraria más. Es decir, no se respetará la configuración de delayInMinutes o periodInMinutes en menos de 1 segundo y se generará una advertencia. when se puede configurar para que se active menos de 1 segundo después de "ahora" sin advertencia, pero no hará que la alarma se active durante al menos 1 segundo.

Parámetros

  • nombre

    string opcional

    Nombre opcional para identificar esta alarma. La configuración predeterminada es la cadena vacía.

  • alarmInfo

    AlarmCreateInfo

    Describe cuándo se debe activar la alarma. La hora inicial se debe especificar con when o delayInMinutes (pero no con ambos). Si se establece periodInMinutes, la alarma se repetirá cada periodInMinutes minutos después del evento inicial. Si no se configuran when ni delayInMinutes para una alarma repetitiva, se usa periodInMinutes como el valor predeterminado de delayInMinutes.

Muestra

  • Promise<void>

    Chrome 111 y versiones posteriores

    Es una promesa que se resuelve cuando se crea la alarma.

get()

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

Recupera detalles sobre la alarma especificada.

Parámetros

  • nombre

    string opcional

    Es el nombre de la alarma que se obtendrá. La configuración predeterminada es la cadena vacía.

Muestra

  • Promise<Alarm | undefined>

    Chrome 91 y versiones posteriores

getAll()

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

Obtiene un array de todas las alarmas.

Muestra

  • Promise<Alarm[]>

    Chrome 91 y versiones posteriores

Eventos

onAlarm

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

Se activa cuando transcurre una alarma. Es útil para las páginas de eventos.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (alarm: Alarm) => void