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
browser.alarms.create(
name, // optional string
alarmInfo // optional object
)
Parameter
name
Optional-
string
. Ein Name für den Alarm. Standardmäßig der leere String.Dies kann verwendet werden, um sich auf einen bestimmten Alarm in
alarms.get()
undalarms.clear()
zu beziehen. Es wird auch inalarms.onAlarm
als die Eigenschaftname
desalarms.Alarm
-Objekts verfügbar sein, das in die Listener-Funktion übergeben wird.Alarame haben eindeutige Namen im Rahmen einer einzelnen Erweiterung. Wenn ein Alarm mit demselben Namen existiert, wird der bestehende Alarm gelöscht und der gerade erstellte Alarm ersetzt ihn.
alarmInfo
Optional-
object
. Sie können dies verwenden, um anzugeben, wann der Alarm das erste Mal ausgelöst wird, entweder als absoluter Wert (when
) oder als Verzögerung ab dem Zeitpunkt der Alarmeinstellung (delayInMinutes
). Um den Alarm regelmäßig auszulösen, geben SieperiodInMinutes
an.In Chrome dürfen Alarme, es sei denn, die Erweiterung ist ohne Verpackung geladen, nicht mehr als einmal pro Minute ausgelöst werden. Wenn eine Erweiterung versucht
delayInMinutes
auf einen Wert < 1 oderwhen
auf einen Wert < 1 Minute in der Zukunft einzustellen, wird der Alarm nach 1 Minute ausgelöst. Wenn eine Erweiterung versuchtperiodInMinutes
auf einen Wert < 1 einzustellen, 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 SieDate.now()
. Wenn Siewhen
angeben, geben SiedelayInMinutes
nicht an. delayInMinutes
Optional-
double
. Die Zeit, zu der der Alarm das erste Mal ausgelöst wird, angegeben als Minuten ab der Alarmeinstellung. Wenn SiedelayInMinutes
angeben, geben Siewhen
nicht an. periodInMinutes
Optional-
double
. Wenn dies angegeben ist, wird der Alarm wiederholt alleperiodInMinutes
nach seiner ersten Auslösung erneut ausgelöst. Wenn Sie diesen Wert angeben, können Sie sowohlwhen
als auchdelayInMinutes
weglassen, und der Alarm wird dann zunächst nachperiodInMinutes
ausgelöst. WirdperiodInMinutes
nicht angegeben, wird der Alarm nur einmal ausgelöst.
Rückgabewert
Ein Promise
, das ohne Argumente erfüllt wird.
Beispiele
Erstellen Sie einen einmaligen, auf Verzögerung basierenden Alarm mit "" als Name:
function onAdded() {
console.log("Alarm Added!");
}
let delayInMinutes = 5;
let addingAlarm = browser.alarms.create({
delayInMinutes,
});
addingAlarm.then(onAdded);
Erstellen Sie einen periodischen, auf Verzögerung basierenden Alarm mit dem Namen "my-periodic-alarm":
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":
const when = 1545696000;
const periodInMinutes = 2;
browser.alarms.create("my-periodic-alarm", {
when,
periodInMinutes,
});
Browser-Kompatibilität
Hinweis:
Diese API basiert auf Chromiums chrome.alarms
API.