alarms.get()

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

Syntax

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

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

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

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

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);