chroom.alarmen

Beschrijving

Machtigingen

Om de chrome.alarms API te gebruiken, declareert u de machtiging "alarms" in het manifest :

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

Begrippen en gebruik

Om betrouwbaar gedrag te garanderen, is het handig om te begrijpen hoe de API zich gedraagt.

Apparaat slaapstand

Alarmen blijven afgaan terwijl een apparaat in de slaapstand staat. Een alarm activeert een apparaat echter niet. Wanneer het apparaat ontwaakt, gaan gemiste alarmen af. Herhaalde alarmen gaan maximaal één keer af en worden vervolgens opnieuw gepland met de opgegeven periode vanaf het moment dat het apparaat ontwaakt. Hierbij wordt geen rekening gehouden met de tijd die is verstreken sinds het alarm oorspronkelijk is ingesteld.

Vasthoudendheid

Alarmen blijven over het algemeen actief totdat een extensie is bijgewerkt. Dit is echter niet gegarandeerd en alarmen kunnen worden gewist wanneer de browser opnieuw wordt opgestart. Overweeg daarom om een waarde in te stellen in de opslag wanneer een alarm wordt aangemaakt en zorg ervoor dat deze aanwezig is telkens wanneer uw service worker opstart. Bijvoorbeeld:

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

Voorbeelden

De volgende voorbeelden laten zien hoe u een alarm kunt gebruiken en erop kunt reageren. Om deze API uit te proberen, installeert u het Alarm API-voorbeeld uit de repository chrome-extension-samples .

Stel een alarm in

In het volgende voorbeeld wordt een alarm ingesteld in de service worker wanneer de extensie wordt geïnstalleerd:

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

Reageren op een alarm

In het volgende voorbeeld wordt het pictogram in de actiebalk ingesteld op basis van de naam van het alarm dat is afgegaan.

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