alarms

Jump to:
  1. Types
  2. Methods
  3. Events
  4. Example extensions
  5. Browser compatibility

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. Alarms do not persist across browser sessions.

To use this API you need to have the "alarms" permission.

Types

alarms.Alarm
Information about a particular alarm.

Methods

alarms.clear()
Clear a specific alarm, given its name.
alarms.clearAll()
Clear all scheduled alarms.
alarms.create()
Create a new alarm.
alarms.get()
Retrieves a specific alarm, given its name.
alarms.getAll()
Retrieve all scheduled alarms.

Events

alarms.onAlarm
Fired when an alarm goes off.

Example extensions

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
AlarmChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48
clearChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48
clearAllChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48
createChrome Full support YesEdge No support NoFirefox Full support 45
Full support 45
No support 45 — 64
Notes
Notes Alarms scheduled for a time in the past never fire.
Opera Full support YesFirefox Android Full support 48
Full support 48
No support 48 — 64
Notes
Notes Alarms scheduled for a time in the past never fire.
getChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48
getAllChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48
onAlarmChrome Full support YesEdge No support NoFirefox Full support 45Opera Full support YesFirefox Android Full support 48

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.
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

Tags: 
Contributors to this page: chrisdavidmills, irenesmith, mdnwebdocs-bot, jeremiahlee, fscholz, wbamberg, ExE-Boss, evilpie
Last updated by: chrisdavidmills,