alarms

Schedule code to run at a specific time in the future. This is like Window.setTimeout() and Window.setInterval(), except that those functions don't work with background pages that are loaded on demand.

Alarms do not persist across browser sessions. They are created globally across all contexts of a single extension. E.g. alarm created in background script will fire onAlarm event in background script, options page, popup page and extension tabs (and vice versa). Alarms API is not available in Content scripts.

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

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
alarms
Alarm
clear
clearAll
create
get
getAll
onAlarm

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

Note: This API is based on Chromium's chrome.alarms API.