W3cubDocs

/Web Extensions

clear()

Use BrowserSetting.clear() to clear any changes the extension has made to the browser setting. The browser setting will revert to its previous value.

The extension will also give up control of the setting, allowing an extension with lower precedence (that is, an extension that was installed before this one) to modify the setting. See BrowserSetting.set() to learn more about controlling settings.

This is an asynchronous function that returns a Promise. If clearing the value failed, the promise resolves to false. If clearing the value succeeded it resolves to true.

Syntax

var clearing = setting.clear(
  details     // object
)

Parameters

details
An empty object.

Return value

A Promise that will be fulfilled with a boolean: true if the setting was cleared, false otherwise.

Browser compatibility

Example

Clear the webRTCIPHandlingPolicy setting:

function onCleared(result) {
  if (result) {
    console.log("Setting was cleared");
  } else {
    console.log("Setting was not cleared");
  }
}

var clearing = browser.privacy.network.webRTCIPHandlingPolicy.clear({});
clearing.then(onCleared);

Note:

This API is based on Chromium's chrome.types API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/types/BrowserSetting/clear