alarms.get()

Gets an alarm, given its name. The alarm is passed into a callback function as an alarms.Alarm object.

Syntax

browser.alarms.get(
  name,                   // string
  function(alarm) {...}   // function
)

Parameters

nameOptional
string. The name of the alarm to get. If you don't supply this, the empty string "" will be used.
callback
function. The function is passed the following arguments:
alarm
alarms.Alarm. The alarm whose name matches name. If no alarms match, this will be undefined.

Browser compatibility

EdgeFirefoxChromeOpera
Basic support?45.0Yes33
Firefox
Basic support48.0

Examples

Callback-based version:

function gotAlarm(alarm) {
  if (alarm) {
    console.log(alarm.name);
  }
}

chrome.alarms.get("my-periodic-alarm", gotAlarm);

Promise-based version:

function gotAlarm(alarm) {
  if (alarm) {
    console.log(alarm.name);
  }
}

var getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);

Acknowledgements

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

Document Tags and Contributors

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