browser.alarms

Beschrijving

Rechten

Als je de browser.alarms API wilt gebruiken, definieer je het recht "alarms" in het manifest:

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

Concepten en gebruik

Voor betrouwbaar gedrag is het handig om te begrijpen hoe de API zich gedraagt.

Slaapmodus op apparaat

Wekkers blijven actief terwijl een apparaat in de slaapstand staat. Een wekker maakt een apparaat niet wakker. Als het apparaat wordt geactiveerd, gaan gemiste wekkers af. Herhaalde wekkers gaan maximaal één keer af en worden daarna opnieuw gepland met de aangegeven periode vanaf het moment dat het apparaat wordt geactiveerd. Er wordt geen rekening gehouden met de tijd die al is verstreken sinds de wekker oorspronkelijk is ingesteld.

Persistentie

Je kunt de persistentie van een alarm bepalen op het moment dat je het maakt met de vlag persistAcrossSessions. Je kunt dit instellen op true (blijft bestaan totdat de extensie wordt geüpdatet) of false (wordt gewist als de extensie opnieuw wordt geladen of de browser opnieuw wordt opgestart en wanneer de extensie wordt geüpdatet).

Andere browsers en eerdere versies van Chrome

Deze property wordt niet ondersteund in andere browsers (probleem) of in versies van Chrome vóór Chrome 150, waar het gedrag onvoorspelbaar kan zijn. Daarom kun je het beste zorgen dat belangrijke alarmen bestaan elke keer dat je servicemedewerker wordt opgestart. Voorbeeld:

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

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

checkAlarmState();

Als je wekker dynamisch wordt gemaakt op basis van een gebruikersactie, kun je ergens anders opslaan dat er een wekker is gemaakt, zodat je weet dat je deze zo nodig opnieuw moet maken.

Voorbeelden

In de volgende voorbeelden zie je hoe je een wekker gebruikt en erop reageert. Als je deze API wilt proberen, installeer je het voorbeeld van de Alarm API uit de repository chrome-extension-samples.

Een wekker zetten

In het volgende voorbeeld wordt een alarm ingesteld in de servicemedewerker wanneer een nieuwe versie van de extensie wordt geïnstalleerd:

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

Reageren op een alarm

In het volgende voorbeeld wordt het icoon van de actiewerkbalk ingesteld op basis van de naam van de wekker die is afgegaan.

service-worker.js:

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

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

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

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