alarms.get()
Gets an alarm, given its name.
This is an asynchronous function that returns a Promise
.
Syntax
var getAlarm = browser.alarms.get(
name // optional string
)
Parameters
Return value
A Promise
that will be fulfilled with an
object. This represents the alarm whose name matches Alarm
name
. If no alarms match, this will be undefined
.
Examples
function gotAlarm(alarm) {
if (alarm) {
console.log(alarm.name);
}
}
var getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
get | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support45 | OperaFull supportYes | SafariFull support14 | Firefox for AndroidFull support48 |
Legend
- Full support
- Full support
The compatibility table on 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.
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.