This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The Permissions.query()
method of the Permissions
interface returns the state of a user permission on the global scope.
Syntax
navigator.permissions.query(PermissionDescriptor).then(function(permissionStatus) { ... })
Parameters
PermissionDescriptor
- An object that sets options for the
query
operation consisting of a comma-separated list of name-value pairs. The available options are:name
: The name of the API whose permissions you want to query. An up-to-date list of permission names can be found in the spec under the PermissionName enum, but bear in mind that the actual permissions supported by browsers is currently much smaller than this. Firefox for example currently supportsgeolocation
,notifications
,push
, andpersistent-storage
(see ourPermissions.webidl
file).userVisibleOnly
: (Push only, not supported in Firefox — see the Browser Support section below) Indicates whether you want to show a notification for every message or be able to send silent push notifications. The default isfalse
.sysex
: (Midi only) Indicates whether you need and/or receive system exclusive messages. The default isfalse
.
Note: As of Firefox 44, the permissions for Notifications and Push have been merged. If permission is granted (e.g. by the user, in the relevant permissions dialog), navigator.permissions.query()
will return true
for both notifications
and push
.
Note: The persistent-storage
permission allows an origin to use a persistent box (i.e persistent storage) for its storage, as per the Storage API.
Returns
A Promise
that resolves to a PermissionStatus
object.
Exceptions
Exception | Explanation |
---|---|
TypeError |
Retrieving the PermissionDescriptor information failed in some way, or the permission doesn't exist or is currently unsupported (e.g. midi , or push with userVisibleOnly ). |
Example
navigator.permissions.query({name:'geolocation'}).then(function(result) { if (result.state == 'granted') { showLocalNewsWithGeolocation(); } else if (result.state == 'prompt') { showButtonToEnableLocalNews(); } // Don't do anything if the permission was denied. });
Specification
Specification | Status | Comment |
---|---|---|
Permissions The definition of 'query()' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
query | Chrome Full support 43 | Edge Full support 79 | Firefox Full support 46 | IE No support No | Opera Full support Yes | Safari No support No | WebView Android Full support 43 | Chrome Android Full support 43 | Firefox Android Full support 46 | Opera Android Full support Yes | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
Legend
- Full support
- Full support
- No support
- No support