Cancels all active alarms.
Syntax
chrome.alarms.clearAll( function(wasCleared) {...} // function )
This API is also available as browser.alarms.clearAll()
in a version that returns a promise.
Parameters
callback
function
. The function is passed the following arguments:-
wasCleared
boolean
.true
if any alarms were cleared,false
otherwise. Note that Chrome always passestrue
here.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | Yes | No | 45.0 | 48.0 | 33 |
Examples
Callback-based version:
function onClearedAll(wasCleared) { console.log(wasCleared); // true/false } chrome.alarms.clearAll(onClearedAll);
Promise-based version:
function onClearedAll(wasCleared) { console.log(wasCleared); // true/false } var clearAlarms = browser.alarms.clearAll(); clearAlarms.then(onClearedAll);
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.