alarms.clear()
Cancels an alarm, given its name.
This is an asynchronous function that returns a Promise
.
Syntax
var clearAlarm = browser.alarms.clear(
name // string
)
Parameters
Return value
A Promise
that will be fulfilled with a boolean. This will be true
if the alarm was cleared, false
otherwise.
Examples
function onCleared(wasCleared) {
console.log(wasCleared); // true/false
}
var clearAlarm = browser.alarms.clear("my-periodic-alarm");
clearAlarm.then(onCleared);
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
clear | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support45 | OperaFull supportYes | SafariFull support14 | Firefox for AndroidFull support48 |
Legend
- Full support
- Full support
The compatibility table on 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.
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.