alarms.getAll()

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

Syntax

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

This API is also available as browser.alarms.getAll() in a version that returns a promise.

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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 45.0 48.0 33

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.

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: Makyen, wbamberg
 Last updated by: Makyen,