Revision 1131259 of management.getPermissionWarningsByManifest()

<div>{{AddonSidebar()}}</div>

<div>When the user installs or upgrades an add-on, the browser may warn the user about any particularly powerful <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions">permissions</a> that the add-on has requested. Not all permissions result in warnings, and this behavior is not standardised across browsers.</div>

<div>&nbsp;</div>

<p>Given the text of a <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json">manifest.json</a> file, this function returns the permission warnings that would be given for the resulting add-on, as an array of strings.</p>

<p>This API <em>does not</em> require the "management" <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/permissions">API permission</a>.</p>

<h2 id="Syntax">Syntax</h2>

<pre class="syntaxbox brush:js">
chrome.management.getPermissionWarningsByManifest(
  manifestString,      // string
  function(info) {...} // function
)
</pre>

<p>This API is also available as <code>browser.management.getPermissionWarningsByManifest()</code> in a <a href="/en-US/Add-ons/WebExtensions/Using_the_JavaScript_APIs#Callbacks_and_promises">version that returns a promise</a>.</p>

<h3 id="Parameters">Parameters</h3>

<dl>
 <dt><code>manifestString</code></dt>
 <dd><code>string</code>. String containing the manifest file. This must be a valid manifest: for example, it must contain all the mandatory manifest keys.</dd>
</dl>

<dl>
 <dt><code>callback{{optional_inline}}</code></dt>
 <dd><code>function</code>. The function is passed the following arguments:</dd>
 <dd>
 <dl class="reference-values">
  <dt><code>permissionWarnings</code></dt>
  <dd>An array of strings, each of which contains the text of a permission warning.</dd>
 </dl>
 </dd>
</dl>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p>

<p>{{WebExtBrowserCompat}}</p>

<h2 id="Examples">Examples</h2>

<p>Log the permission warnings for the given manifest file:</p>

<pre class="brush: js">
var manifest = {
  "manifest_version": 2,
  "name": "test",
  "version": "1.0",
  "permissions": ["management", "&lt;all_urls&gt;"]
}

var manifestString = JSON.stringify(manifest);

function gotWarnings(warnings) {
  if (chrome.runtime.lastError) {
    console.log(chrome.runtime.lastError);
  } else {
    console.log(warnings);
  }
}

chrome.management.getPermissionWarningsByManifest(manifestString, gotWarnings);
</pre>

<p>{{WebExtExamples}}</p>

<div class="note"><strong>Acknowledgements</strong>

<p>This API is based on Chromium's <a href="https://developer.chrome.com/extensions/management#method-getPermissionWarningsByManifest"><code>chrome.management</code></a> API. This documentation is derived from <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/management.json"><code>management.json</code></a> in the Chromium code.</p>

<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</p>
</div>

<div class="hidden">
<pre>
// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>