PermissionRequest QML Type

Generic permission request More...

Import Statement: import com.canonical.Oxide 1.15
Instantiates: OxideQPermissionRequest
Inherited By:

GeolocationPermissionRequest and MediaAccessPermissionRequest

Properties

Signals

Methods

Detailed Description

PermissionRequest represents a request for permission to access a specific resource. The permission request does not indicate the type of resource that the request is for, but instead, this is indicated by the source of the request.

It is assumed that the application will display a UI to request permission from the user.

The origin of the site that this request originates from can be accessed using origin.

The application can respond to this request by calling allow (which will permit access to the resource) or deny (which will deny access to the resource).

If the request instance is deleted before the application has called allow or deny, the request will be automatically declined.

Property Documentation

embedder : url

The origin of the top-level page that hosts the page requesting access to the resource.

If the request originates from the main frame, this will be equal to origin.


isCancelled : bool

The permission request has been cancelled. This could be because the originating frame navigated to another page or was deleted.

If the application is displaying a permission request UI to the user, it should hide it when this property indicates that the request has been cancelled.

Note: The notify signal for this is cancelled.


origin : url

The origin of the page requesting access to the resource.

This QML property was introduced in OxideQt 1.8.


Signal Documentation

void cancelled()

Indicates that the permission request has been cancelled.

See also isCancelled.


Method Documentation

void allow()

Permit access to the resource for which this permission request requests access, for the specified origin / embedder combination.


void deny()

Decline access to the resource for which this permission request requests access.