chrome.alarms

Beschreibung

Berechtigungen

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

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

Konzepte und Verwendung

Um ein zuverlässiges Verhalten zu gewährleisten, ist es hilfreich zu verstehen, wie sich die API verhält.

Ruhemodus

Alarme werden auch dann ausgeführt, wenn sich ein Gerät im Ruhemodus befindet. Ein Alarm kann ein Gerät jedoch nicht aus dem Ruhemodus holen. Wenn das Gerät aufwacht, werden alle verpassten Alarme 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 und nicht die Zeit, die seit dem ursprünglichen Festlegen des Alarms vergangen ist.

Persistenz

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

Andere Browser und frühere Chrome-Versionen

Diese Property wird in anderen Browsern (Problem) oder in Chrome-Versionen vor Chrome 150 nicht unterstützt. In diesen Versionen kann das Verhalten unvorhersehbar sein. Daher sollten Sie dafür 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 Alarm dynamisch basierend auf einer Nutzeraktion erstellt wird, sollten Sie speichern, dass ein Alarm an anderer Stelle erstellt wurde, damit Sie ihn bei Bedarf neu erstellen können.

Beispiele

In den folgenden Beispielen wird gezeigt, wie Sie einen Alarm verwenden und darauf reagieren. Wenn Sie diese API testen möchten, installieren Sie das Beispiel für die Alarm API aus dem Repository chrome-extension-samples.

Wecker stellen

Im folgenden Beispiel wird ein Alarm im Service Worker 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 der 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,
)