permissions.contains()

Check whether the extension has the permissions listed in the given permissions.Permissions object.

The Permissions argument may contain either an origins property, which is an array of host permissions, or a permissions property, which is an array of API permissions, or both.

This is an asynchronous function that returns a Promise. The promise is fulfilled with true only if all the extension currently has all the given permissions. For host permissions, if the extension's permissions pattern-match the permissions listed in origins, then they are considered to match.

Syntax

var getContains = browser.permissions.contains(
  permissions                // Permissions object
)

Parameters

permissions

A permissions.Permissions object.

Return value

A Promise that will be fulfilled with true if the extension already has all the permissions listed in the permissions argument, or false otherwise.

Browser compatibility

The compatibility table in 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

// Extension permissions are:
// "webRequest", "tabs", "*://*.mozilla.org/*"
var testPermissions1 = {
  origins: ["*://mozilla.org/"],
  permissions: ["tabs"]
};
browser.permissions.contains(testPermissions1).then((result) => {
  console.log(result);    // true
});
var testPermissions2 = {
  origins: ["*://mozilla.org/"],
  permissions: ["tabs", alarms"]
};
browser.permissions.contains(testPermissions2).then((result) => {
  console.log(result);   // false, "alarms" doesn't match
});
var testPermissions3 = {
  origins: ["https://developer.mozilla.org/"],
  permissions: ["tabs", "webRequest"]
};
browser.permissions.contains(testPermissions3).then((result) => {
  console.log(result);   // true: "https://developer.mozilla.org/"
});                      // matches: "*://*.mozilla.org/*"
var testPermissions4 = {
  origins: ["https://example.org/"]
}; 
browser.permissions.contains(testPermissions4).then((result) => {
  console.log(result);   // false, "https://example.org/"
});                      // does not match