alarms.create()

Erstellt einen neuen Alarm für die aktuelle Browsersitzung. Ein Alarm kann einmal oder mehrfach ausgelöst werden. Ein Alarm wird gelöscht, nachdem er das letzte Mal ausgelöst wurde.

Syntax

js
browser.alarms.create(
  name,              // optional string
  alarmInfo          // optional object
)

Parameter

name Optional

string. Ein Name für den Alarm. Standardmäßig ist dies der leere String.

Dies kann verwendet werden, um auf einen bestimmten Alarm in alarms.get() und alarms.clear() zu verweisen. Er wird auch in alarms.onAlarm als name-Eigenschaft des alarms.Alarm Objekts verfügbar sein, das an die Listener-Funktion übergeben wird.

Alarmnamen sind eindeutig im Bereich einer einzelnen Erweiterung. Wenn ein Alarm mit demselben Namen bereits existiert, wird der bestehende Alarm gelöscht und durch den neu erstellten Alarm ersetzt.

alarmInfo Optional

object. Dies kann verwendet werden, um anzugeben, wann der Alarm erstmals ausgelöst wird, entweder als absoluter Wert (when), oder als Verzögerung ab der Zeit, zu der der Alarm gesetzt wird (delayInMinutes). Um den Alarm wiederkehrend zu machen, geben Sie periodInMinutes an.

In Chrome dürfen Alarme, die von einer unverpackt geladenen Erweiterung erstellt werden, nicht öfter als einmal pro Minute ausgelöst werden. Wenn eine Erweiterung versucht, delayInMinutes auf einen Wert < 1 zu setzen, oder when auf einen Wert < 1 Minute in der Zukunft, dann wird der Alarm nach 1 Minute ausgelöst. Wenn eine Erweiterung versucht, periodInMinutes auf einen Wert < 1 zu setzen, dann wird der Alarm jede Minute ausgelöst.

Das alarmInfo-Objekt kann die folgenden Eigenschaften enthalten:

when Optional

double. Die Zeit, zu der der Alarm das erste Mal ausgelöst wird, angegeben als Millisekunden seit der Epoche. Um die Anzahl der Millisekunden zwischen der Epoche und der aktuellen Zeit zu erhalten, verwenden Sie Date.now(). Wenn Sie when angeben, geben Sie delayInMinutes nicht an.

delayInMinutes Optional

double. Die Zeit, zu der der Alarm das erste Mal ausgelöst wird, angegeben als Minuten ab der Zeit, zu der der Alarm gesetzt wird. Wenn Sie delayInMinutes angeben, geben Sie when nicht an.

periodInMinutes Optional

double. Wenn dies angegeben wird, wird der Alarm nach seinem ersten Auslösen alle periodInMinutes erneut ausgelöst. Wenn Sie diesen Wert angeben, können Sie sowohl when als auch delayInMinutes auslassen, und der Alarm wird dann initial nach periodInMinutes ausgelöst. Wenn periodInMinutes nicht angegeben ist, wird der Alarm nur einmal ausgelöst.

Rückgabewert

Ein Promise, das ohne Argumente erfüllt wird.

Beispiele

Erstellen Sie einen einmaligen, verzögerungsbasierten Alarm mit "" als Namen:

js
function onAdded() {
  console.log("Alarm Added!");
}

let delayInMinutes = 5;

let addingAlarm = browser.alarms.create({
  delayInMinutes,
});
addingAlarm.then(onAdded);

Erstellen Sie einen periodischen, verzögerungsbasierten Alarm mit dem Namen "my-periodic-alarm":

js
const delayInMinutes = 5;
const periodInMinutes = 2;

browser.alarms.create("my-periodic-alarm", {
  delayInMinutes,
  periodInMinutes,
});

Erstellen Sie einen periodischen, absoluten Alarm mit dem Namen "my-periodic-alarm":

js
const when = 1545696000;
const periodInMinutes = 2;

browser.alarms.create("my-periodic-alarm", {
  when,
  periodInMinutes,
});

Browser-Kompatibilität

Hinweis: Diese API basiert auf der chrome.alarms API von Chromium.