alarms.create()
Erstellt einen neuen Alarm für die aktuelle Browsersitzung. Ein Alarm kann einmal oder mehrmals 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 auf einen bestimmten Alarm in
alarms.get()
undalarms.clear()
zu verweisen. Es wird auch inalarms.onAlarm
als diename
-Eigenschaft desalarms.Alarm
-Objekts verfügbar sein, das an die Listener-Funktion übergeben wird.Alarmnamen sind innerhalb des Bereichs einer einzelnen Erweiterung eindeutig. Wenn ein Alarm mit demselben Namen existiert, wird der vorhandene Alarm gelöscht und der neu erstellte Alarm ersetzt diesen.
alarmInfo
Optional-
object
. Damit kann festgelegt werden, wann der Alarm erstmals ausgelöst wird, entweder als absoluter Wert (when
) oder als Verzögerung ab dem Zeitpunkt, an dem der Alarm gesetzt wird (delayInMinutes
). Um den Alarm wiederholt auszulösen, geben SieperiodInMinutes
an.In Chrome dürfen, sofern die Erweiterung nicht entpackt geladen wird, Alarme 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 versucht,periodInMinutes
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 in 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 Sie nichtdelayInMinutes
an. delayInMinutes
Optional-
double
. Die Zeit, zu der der Alarm das erste Mal ausgelöst wird, angegeben in Minuten ab dem Zeitpunkt, an dem der Alarm gesetzt wird. Wenn SiedelayInMinutes
angeben, geben Sie nichtwhen
an. periodInMinutes
Optional-
double
. Wenn dies angegeben ist, wird der Alarm nach seiner erstmaligen Auslösung alleperiodInMinutes
erneut ausgelöst. Wenn Sie diesen Wert angeben, können Sie sowohlwhen
als auchdelayInMinutes
weglassen, und der Alarm wird dann initial nachperiodInMinutes
ausgelöst. WennperiodInMinutes
nicht angegeben ist, wird der Alarm nur einmal ausgelöst.
Rückgabewert
Ein Promise
, das ohne Argumente erfüllt wird.
Beispiele
Erstellen Sie einen einmalig verzögerten 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 verzögerten Alarm namens "my-periodic-alarm":
const delayInMinutes = 5;
const periodInMinutes = 2;
browser.alarms.create("my-periodic-alarm", {
delayInMinutes,
periodInMinutes,
});
Erstellen Sie einen periodischen absoluten Alarm namens "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 der chrome.alarms
-API von Chromium.