get()

The BrowserSetting.get() method gets the current value of the browser setting, and an enumeration indicating how the setting's value is currently controlled.

This is an asynchronous function that returns a Promise.

Syntax

var getting = setting.get(
  details     // object
)

Parameters

details
An empty object.

Return value

A Promise that will be fulfilled with an object with the following properties:

value
The value of the setting. The type of this property is determined by the particular setting.
levelOfControl
string. This represents the way the setting is currently controlled. You can use it to check whether you can modify the setting. See BrowserSetting.set() for details. Its value may be any of the following:
"not_controllable" Extensions are not allowed to modify this setting.
"controlled_by_other_extensions" Another extension that was installed after this one has modified this setting.
"controllable_by_this_extension" This extension is allowed to modify the setting.
controlled_by_this_extension" This extension has already modified the setting.

Browser compatibility

See types.BrowserSetting.

Example

Log the value and level of control for the networkPredictionEnabled property of the privacy.network object, for private browsing windows.

var getting = browser.privacy.network.networkPredictionEnabled.get({});
getting.then((got) => {
  console.log(`Value: ${got.value}`);
  console.log(`Control: ${got.levelOfControl}`);
});

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