alarms.getAll()

Gets all active alarms. The alarms are passed into a callback, as an array of alarms.Alarm objects.

Syntax

browser.alarms.getAll(
  function(array) {...}   // function
)

Parameters

callback
function. The function is passed the following arguments:
alarms
array of alarms.Alarm. All active alarms. If no alarms are active, the array will be empty.

Browser compatibility

EdgeFirefoxChromeOpera
Basic support?45.0Yes33
Firefox
Basic support48.0

Examples

Callback-based version:

function gotAll(alarms) {
  for (var alarm of alarms) {
    console.log(alarm.name);
  }
}

chrome.alarms.getAll(gotAll);

Promise-based version:

function gotAll(alarms) {
  for (var alarm of alarms) {
    console.log(alarm.name);
  }
}

var getAlarms = browser.alarms.getAll();
getAlarms.then(gotAll);

Acknowledgements

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

Document Tags and Contributors

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