alarms

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

Chrome Edge Firefox Firefox for Android Opera
Alarm Yes No 45.0 48.0 33
clear Yes No 45.0 48.0 33
clearAll Yes No 45.0 48.0 33
create Yes No 45.0 48.0 33
get Yes No 45.0 48.0 33
getAll Yes No 45.0 48.0 33
onAlarm Yes No 45.0 48.0 33

Chrome incompatibilities

None.

Example add-ons

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.

Document Tags and Contributors

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