alarms.create()
Creates a new alarm for the current browser session. An alarm may fire once or multiple times. An alarm is cleared after it fires for the last time.
Syntax
browser.alarms.create(
name, // optional string
alarmInfo // optional object
)
Parameters
name
Optional-
string
. A name for the alarm. Defaults to the empty string.This can be used to refer to a particular alarm in
alarms.get()
andalarms.clear()
. It will also be available inalarms.onAlarm
as thename
property of thealarms.Alarm
object passed into the listener function.Alarm names are unique within the scope of a single extension. If an alarm with an identical name exists, the existing alarm will be cleared and the alarm being created will replace it.
alarmInfo
Optional-
object
. You can use this to specify when the alarm will initially fire, either as an absolute value (when
), or as a delay from the time the alarm is set (delayInMinutes
). To make the alarm recur, specifyperiodInMinutes
.On Chrome, unless the extension is loaded unpackaged, alarms it creates are not allowed to fire more than once per minute. If an extension tries to set
delayInMinutes
to a value < 1, orwhen
to a value < 1 minute in the future, then the alarm will fire after 1 minute. If an extension tries to setperiodInMinutes
to a value < 1, then the alarm will fire every minute.The
alarmInfo
object may contain the following properties:when
Optional-
double
. The time the alarm will fire first, given as milliseconds since the epoch. To get the number of milliseconds between the epoch and the current time, useDate.now()
. If you specifywhen
, don't specifydelayInMinutes
. delayInMinutes
Optional-
double
. The time the alarm will fire first, given as minutes from the time the alarm is set. If you specifydelayInMinutes
, don't specifywhen
. periodInMinutes
Optional-
double
. If this is specified, the alarm will fire again everyperiodInMinutes
after its initial firing. If you specify this value you may omit bothwhen
anddelayInMinutes
, and the alarm will then fire initially afterperiodInMinutes
. IfperiodInMinutes
is not specified, the alarm will only fire once.
Examples
Create a one-time delay-based alarm with "" for the name:
const delayInMinutes = 5;
browser.alarms.create({
delayInMinutes,
});
Create a periodic delay-based alarm named "my-periodic-alarm":
const delayInMinutes = 5;
const periodInMinutes = 2;
browser.alarms.create("my-periodic-alarm", {
delayInMinutes,
periodInMinutes,
});
Create a periodic absolute alarm named "my-periodic-alarm":
const when = 1545696000;
const periodInMinutes = 2;
browser.alarms.create("my-periodic-alarm", {
when,
periodInMinutes,
});
Browser compatibility
BCD tables only load in the browser
Note:
This API is based on Chromium's chrome.alarms
API.