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
name
Optional
. The name of the alarm to get. If you don't supply this, the empty string "" will be used.string
callback
function
. The function is passed the following arguments:-
alarm
. The alarm whose name matchesalarms.Alarm
name
. If no alarms match, this will beundefined
.
Browser compatibility
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.