management.getPermissionWarningsByManifest()
When the user installs or upgrades an add-on, the browser may warn the user about any particularly powerful permissions that the add-on has requested. Not all permissions result in warnings, and this behavior is not standardised across browsers.
Given the text of a manifest.json file, this function returns the permission warnings that would be given for the resulting add-on, as an array of strings.
This API does not require the "management" API permission.
This is an asynchronous function that returns a Promise
.
Syntax
var gettingWarnings = browser.management.getPermissionWarningsByManifest(
manifestString // string
)
Parameters
Return value
A Promise
that will be fulfilled with an array of strings, each of which contains the text of a permission warning.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
getPermissionWarningsByManifest | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
Legend
- Full support
- Full support
- No support
- No 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.
Examples
Log the permission warnings for the given manifest file:
var manifest = {
"manifest_version": 2,
"name": "test",
"version": "1.0",
"permissions": ["management", "<all_urls>"]
}
var manifestString = JSON.stringify(manifest);
function gotWarnings(warnings) {
console.log(warnings);
}
function gotError(error) {
console.log(`Error: ${error}`);
}
var gettingWarnings = browser.management.getPermissionWarningsByManifest(manifestString);
gettingWarnings.then(gotWarnings, gotError);
Acknowledgements
This API is based on Chromium's chrome.management
API. This documentation is derived from management.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.