Gio.Permission¶

class — extends GObject.Object

A GPermission represents the status of the caller’s permission to perform a certain action.

You can query if the action is currently allowed and if it is possible to acquire the permission so that the action will be allowed in the future.

There is also an API to actually acquire the permission and one to release it.

As an example, a GPermission might represent the ability for the user to write to a Settings object. This GPermission object could then be used to decide if it is appropriate to show a “Click here to unlock” button in a dialog and to provide the mechanism to invoke when that button is clicked.

Methods¶

acquire¶

def acquire(self, cancellable: Cancellable | None = ...) -> bool

Attempts to acquire the permission represented by permission.

The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is that a dialog may appear asking the user to enter their password.

You should check with Permission.get_can_acquire before calling this function.

If the permission is acquired then True is returned. Otherwise, False is returned and error is set appropriately.

This call is blocking, likely for a very long time (in the case that user interaction is required). See Permission.acquire_async for the non-blocking version.

Parameters:

cancellable — a Cancellable, or None

acquire_async¶

def acquire_async(self, cancellable: Cancellable | None = ..., callback: Callable[[Permission | None, AsyncResult], None] | None = ...) -> None

Attempts to acquire the permission represented by permission.

This is the first half of the asynchronous version of Permission.acquire.

Parameters:

cancellable — a Cancellable, or None
callback — the GAsyncReadyCallback to call when done

acquire_finish¶

def acquire_finish(self, result: AsyncResult) -> bool

Collects the result of attempting to acquire the permission represented by permission.

This is the second half of the asynchronous version of Permission.acquire.

Parameters:

result — the AsyncResult given to the GAsyncReadyCallback

get_allowed¶

def get_allowed(self) -> bool

Gets the value of the 'allowed' property. This property is True if the caller currently has permission to perform the action that permission represents the permission to perform.

get_can_acquire¶

def get_can_acquire(self) -> bool

Gets the value of the 'can-acquire' property. This property is True if it is generally possible to acquire the permission by calling Permission.acquire.

get_can_release¶

def get_can_release(self) -> bool

Gets the value of the 'can-release' property. This property is True if it is generally possible to release the permission by calling Permission.release.

impl_update¶

def impl_update(self, allowed: bool, can_acquire: bool, can_release: bool) -> None

This function is called by the Permission implementation to update the properties of the permission. You should never call this function except from a Permission implementation.

GObject notify signals are generated, as appropriate.

Parameters:

allowed — the new value for the 'allowed' property
can_acquire — the new value for the 'can-acquire' property
can_release — the new value for the 'can-release' property

release¶

def release(self, cancellable: Cancellable | None = ...) -> bool

Attempts to release the permission represented by permission.

The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the permission will be dropped immediately without further action.

You should check with Permission.get_can_release before calling this function.

If the permission is released then True is returned. Otherwise, False is returned and error is set appropriately.

This call is blocking, likely for a very long time (in the case that user interaction is required). See Permission.release_async for the non-blocking version.

Parameters:

cancellable — a Cancellable, or None

release_async¶

def release_async(self, cancellable: Cancellable | None = ..., callback: Callable[[Permission | None, AsyncResult], None] | None = ...) -> None

Attempts to release the permission represented by permission.

This is the first half of the asynchronous version of Permission.release.

Parameters:

cancellable — a Cancellable, or None
callback — the GAsyncReadyCallback to call when done

release_finish¶

def release_finish(self, result: AsyncResult) -> bool

Collects the result of attempting to release the permission represented by permission.

This is the second half of the asynchronous version of Permission.release.

Parameters:

result — the AsyncResult given to the GAsyncReadyCallback

Virtual methods¶

do_acquire¶

def do_acquire(self, cancellable: Cancellable | None = ...) -> bool

Attempts to acquire the permission represented by permission.

The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is that a dialog may appear asking the user to enter their password.

You should check with Permission.get_can_acquire before calling this function.

If the permission is acquired then True is returned. Otherwise, False is returned and error is set appropriately.

This call is blocking, likely for a very long time (in the case that user interaction is required). See Permission.acquire_async for the non-blocking version.

Parameters:

cancellable — a Cancellable, or None

do_acquire_async¶

def do_acquire_async(self, cancellable: Cancellable | None = ..., callback: Callable[[Permission | None, AsyncResult], None] | None = ...) -> None

Attempts to acquire the permission represented by permission.

This is the first half of the asynchronous version of Permission.acquire.

Parameters:

cancellable — a Cancellable, or None
callback — the GAsyncReadyCallback to call when done

do_acquire_finish¶

def do_acquire_finish(self, result: AsyncResult) -> bool

Collects the result of attempting to acquire the permission represented by permission.

This is the second half of the asynchronous version of Permission.acquire.

Parameters:

result — the AsyncResult given to the GAsyncReadyCallback

do_release¶

def do_release(self, cancellable: Cancellable | None = ...) -> bool

Attempts to release the permission represented by permission.

The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the permission will be dropped immediately without further action.

You should check with Permission.get_can_release before calling this function.

If the permission is released then True is returned. Otherwise, False is returned and error is set appropriately.

This call is blocking, likely for a very long time (in the case that user interaction is required). See Permission.release_async for the non-blocking version.

Parameters:

cancellable — a Cancellable, or None

do_release_async¶

def do_release_async(self, cancellable: Cancellable | None = ..., callback: Callable[[Permission | None, AsyncResult], None] | None = ...) -> None

Attempts to release the permission represented by permission.

This is the first half of the asynchronous version of Permission.release.

Parameters:

cancellable — a Cancellable, or None
callback — the GAsyncReadyCallback to call when done

do_release_finish¶

def do_release_finish(self, result: AsyncResult) -> bool

Collects the result of attempting to release the permission represented by permission.

This is the second half of the asynchronous version of Permission.release.

Parameters:

result — the AsyncResult given to the GAsyncReadyCallback

Properties¶

allowed¶

allowed: bool  # read-only

True if the caller currently has permission to perform the action that permission represents the permission to perform.

can_acquire¶

can_acquire: bool  # read-only

True if it is generally possible to acquire the permission by calling Permission.acquire.

can_release¶

can_release: bool  # read-only

True if it is generally possible to release the permission by calling Permission.release.