Permissions: revoke() method

Note: This feature is available in Web Workers.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The revoke() method of the Permissions interface reverts a currently set permission back to its default state, which is usually prompt. This method is called on the global Permissions object navigator.permissions.

This method is removed from the main permissions API specification because its use case is unclear. Permissions are managed by the browser and the current permission model does not involve the site developer being able to imperatively request or revoke permissions. Browsers have shipped this API behind preferences but it's unlikely to reach the standards track. For more context, see the original discussion to remove permissions.revoke().

Syntax

revoke(descriptor)

Parameters

descriptor

An object based on the PermissionDescriptor dictionary that sets options for the 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. Each browser supports a different set of values. You can consult the Firefox values, the Chromium values, and the WebKit values.
userVisibleOnly: (Push only, not supported in Firefox — see the Browser compatibility section below) Indicates whether you want to show a notification for every message or be able to send silent push notifications. The default is false.
sysex (MIDI only): Indicates whether you need and/or receive system exclusive messages. The default is false.

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.

Return value

A Promise that calls its fulfillment handler with a PermissionStatus object indicating the result of the request.

Exceptions

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).

Examples

This function can be used by an app to request that its own Geolocation API permission be revoked.

function revokePermission() {
  navigator.permissions.revoke({ name: "geolocation" }).then((result) => {
    report(result.state);
  });
}

Specifications

Specification
Relinquishing Permissions # dom-permissions-revoke

Browser compatibility

BCD tables only load in the browser