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 listener argument is the listener to remove.
hasListener(listener)
Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

listener

Function that will be called when this event occurs. The function will be passed the following arguments:

alarm
alarms.Alarm. The alarm that fired. Use Alarm.name to figure out which alarm fired.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYesNo4548Yes

Examples

Handle an alarm going off:

function handleAlarm(alarmInfo) {
  console.log("on alarm: " + alarmInfo.name);
}

browser.alarms.onAlarm.addListener(handleAlarm);

Example extensions

Acknowledgements

This API is based on Chromium's chrome.alarms API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: andrewtruongmoz, wbamberg, Makyen
 Last updated by: andrewtruongmoz,