Schedule code to run at a specific time in the future. This is like setTimeout() and setInterval(), except that those functions don't work with background pages that are loaded on demand.
To use this API you need to have the "alarms" permission.
Types
alarms.Alarm- Information about a particular alarm.
Functions
alarms.create()- Create a new alarm.
alarms.get()- Retrieves a specific alarm, given its name.
alarms.getAll()- Retrieve all scheduled alarms.
alarms.clear()- Clear a specific alarm, given its name.
alarms.clearAll()- Clear all scheduled alarms.
Events
alarms.onAlarm- Fired when an alarm goes off.
Browser compatibility
| Desktop | Mobile | ||||
|---|---|---|---|---|---|
| Edge | Firefox | Chrome | Opera | Firefox | |
Alarm |
? | 45.0 | Yes | 33 | 48.0 |
clear |
? | 45.0 | Yes | 33 | 48.0 |
clearAll |
? | 45.0 | Yes | 33 | 48.0 |
create |
? | 45.0 | Yes | 33 | 48.0 |
get |
? | 45.0 | Yes | 33 | 48.0 |
getAll |
? | 45.0 | Yes | 33 | 48.0 |
onAlarm |
? | 45.0 | Yes | 33 | 48.0 |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Chrome incompatibilities
None.
Example add-ons
Acknowledgements
This API is based on Chromium's chrome.alarms API.
