clear()

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

The add-on will also give up control of the setting, allowing an add-on with lower precendence (that is, an add-on 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

See privacy.BrowserSetting.

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);

Acknowledgements

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.

Document Tags and Contributors

 Contributors to this page: bunnybooboo, wbamberg
 Last updated by: bunnybooboo,