BrowserSetting

A BrowserSetting is an object representing a browser setting.

It provides methods to set and get the setting's underlying value, to clear any change you've made to it, and to listen for changes to its value.

Note that while this object is based on the ChromeSetting type, this object does not distinguish between setting the value in normal browsing windows and in private browsing windows. This means that all parts of the API relating to proivate browsing (such as the scope option to ChromeSetting.set()) are not implemented.

Methods

privacy.BrowserSetting.get()
Get the current value of the setting, and an enumeration representing how the setting is currently controlled.
privacy.BrowserSetting.set()
Set the setting to a new value.
privacy.BrowserSetting.clear()
Clear any change made to the setting by this add-on.

Events

privacy.BrowserSetting.onChange
Fired when the setting's value changes.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 54 54 Yes

Compatibility notes

Firefox

  • 'onChange' is not supported.

Firefox for Android

  • 'onChange' is not supported.

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: wbamberg
 Last updated by: wbamberg,