alarms.onAlarm
Fired when any alarm set by the extension goes off.
Fired when any alarm set by the extension goes off.
Syntax
browser.alarms.onAlarm.addListener(listener)
browser.alarms.onAlarm.removeListener(listener)
browser.alarms.onAlarm.hasListener(listener)
Events have three functions:
addListener(listener)- : Adds a listener to this event.
removeListener(listener)- : Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)- : Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener- : The function called when this event occurs. The function is passed this argument:
alarm- : alarms.Alarm. The alarm that fired. Use
Alarm.nameto figure out which alarm fired.
Examples
Handle an alarm going off:
function handleAlarm(alarmInfo) {
console.log(`on alarm: ${alarmInfo.name}`);
}
browser.alarms.onAlarm.addListener(handleAlarm);
Browser compatibility
[!NOTE] This API is based on Chromium's
chrome.alarmsAPI.