alarms.onAlarm

Fired when any alarm set by this add-on goes off.

Syntax

chrome.alarms.onAlarm.addListener(function(
  alarm      // Alarm
) {...})
chrome.alarms.onAlarm.removeListener(listener)
chrome.alarms.onAlarm.hasListener(listener)

This API is also available as browser.alarms.onAlarm.*.

Events have three functions:

addListener(callback)

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

callback

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

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Examples

Handle an alarm going off:

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

chrome.alarms.onAlarm.addListener(handleAlarm);

Example add-ons

• chill-out