@types/webextension-polyfill/namespaces/permissions.d.ts

TypeScript definitions for webextension-polyfill

//////////////////////////////////////////////////////
// BEWARE: DO NOT EDIT MANUALLY! Changes will be lost!
//////////////////////////////////////////////////////

import { Events } from "./events";
import { Manifest } from "./manifest";

/**
 * Namespace: browser.permissions
 */
export namespace Permissions {
    interface Permissions {
        /**
         * Optional.
         */
        permissions?: Array<Manifest.OptionalPermission | Manifest.OptionalOnlyPermission>;

        /**
         * Optional.
         */
        origins?: Manifest.MatchPattern[];

        /**
         * Optional.
         */
        data_collection?: Manifest.OptionalDataCollectionPermission[];
    }

    interface AnyPermissions {
        /**
         * Optional.
         */
        permissions?: Array<Manifest.Permission | Manifest.OptionalOnlyPermission>;

        /**
         * Optional.
         */
        origins?: Manifest.MatchPattern[];

        /**
         * Optional.
         */
        data_collection?: Manifest.OptionalDataCollectionPermission[];
    }

    interface Static {
        /**
         * Get a list of all the extension's permissions.
         */
        getAll(): Promise<AnyPermissions>;

        /**
         * Check if the extension has the given permissions.
         */
        contains(permissions: AnyPermissions): Promise<boolean>;

        /**
         * Request the given permissions.
         */
        request(permissions: Permissions): Promise<boolean>;

        /**
         * Relinquish the given permissions.
         */
        remove(permissions: Permissions): Promise<boolean>;

        /**
         * Fired when the extension acquires new permissions.
         */
        onAdded: Events.Event<(permissions: Permissions) => void>;

        /**
         * Fired when permissions are removed from the extension.
         */
        onRemoved: Events.Event<(permissions: Permissions) => void>;
    }
}