management.getPermissionWarningsById()

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 ID of an add-on, this function returns the permission warnings for it as an array of strings.

This API requires the "management" API permission.

This is an asynchronous function that returns a Promise.

Syntax

var gettingWarnings = browser.management.getPermissionWarningsById(
  id                  // string
)

Parameters

id
string. ID of the add-on whose permission warnings you want to retrieve.

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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getPermissionWarningsById
Yes
79
No
?
Yes
No
?
?
No
?
?
?

Examples

Log the permission warnings for the add-on whose ID is "my-add-on":

var id = "my-add-on";

function gotWarnings(warnings) {
  for (warning of warnings) {
    console.log(warning);
  }
}

var gettingWarnings = browser.management.getPermissionWarningsById(id);
gettingWarnings.then(gotWarnings);

Note: 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.

© 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/management/getPermissionWarningsById