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.

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

BCD tables only load in the browser

Note: 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.