chrome.alarms

Beschreibung

Berechtigungen

Wenn Sie die chrome.alarms API verwenden möchten, deklarieren Sie die Berechtigung "alarms" im Manifest:

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

Konzepte und Nutzung

Um ein zuverlässiges Verhalten zu gewährleisten, ist es hilfreich, die Funktionsweise der API zu verstehen.

Ruhemodus

Wecker werden auch dann ausgelöst, wenn sich ein Gerät im Ruhemodus befindet. Ein Wecker kann ein Gerät jedoch nicht aktivieren. Wenn das Gerät aktiviert wird, werden alle verpassten Wecker ausgelöst. Wiederholende Alarme werden höchstens einmal ausgelöst und dann mit dem angegebenen Zeitraum neu geplant. Dabei wird die Zeit ab dem Aufwachen des Geräts berücksichtigt, nicht die Zeit, die seit dem ursprünglichen Auslösen des Alarms vergangen ist.

Persistenz

Sie können die Persistenz eines Alarms bei der Erstellung mit dem Flag persistAcrossSessions steuern. Dies kann auf true (bleibt bis zur Aktualisierung der Erweiterung erhalten) oder false (wird gelöscht, wenn die Erweiterung neu geladen oder der Browser neu gestartet wird und immer, wenn die Erweiterung aktualisiert wird) festgelegt werden.

Andere Browser und frühere Versionen von Chrome

Diese Eigenschaft wird in anderen Browsern (Problem) oder in Chrome-Versionen vor Chrome 150 nicht unterstützt. Das Verhalten kann dort unvorhersehbar sein. Daher ist es am besten, dafür zu sorgen, dass wichtige Alarme jedes Mal vorhanden sind, wenn Ihr Service Worker gestartet wird. Beispiel:

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

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

checkAlarmState();

Wenn Ihr Wecker dynamisch auf Grundlage einer Nutzeraktion erstellt wird, sollten Sie speichern, dass ein Wecker erstellt wurde, damit Sie ihn bei Bedarf neu erstellen können.

Beispiele

Die folgenden Beispiele zeigen, wie Sie einen Alarm verwenden und darauf reagieren. Wenn Sie diese API ausprobieren möchten, installieren Sie das Alarm API-Beispiel aus dem Repository chrome-extension-samples.

Wecker stellen

Im folgenden Beispiel wird im Service Worker ein Alarm festgelegt, wenn eine neue Version der Erweiterung installiert wird:

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

Auf einen Alarm reagieren

Im folgenden Beispiel wird das Symbol für die Aktionsleiste basierend auf dem Namen des ausgelösten Alarms festgelegt.

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