Permission#
Superclasses: Object
Subclasses: SimplePermission
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#
- class Permission
- acquire(cancellable: Cancellable | None = 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
get_can_acquire()
before calling this function.If the permission is acquired then
True
is returned. Otherwise,False
is returned anderror
is set appropriately.This call is blocking, likely for a very long time (in the case that user interaction is required). See
acquire_async()
for the non-blocking version.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
- acquire_async(cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) None #
Attempts to acquire the permission represented by
permission
.This is the first half of the asynchronous version of
acquire()
.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
callback – the
AsyncReadyCallback
to call when doneuser_data – the user data to pass to
callback
- acquire_finish(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
acquire()
.Added in version 2.26.
- Parameters:
result – the
AsyncResult
given to theAsyncReadyCallback
- get_allowed() bool #
Gets the value of the ‘allowed’ property. This property is
True
if the caller currently has permission to perform the action thatpermission
represents the permission to perform.Added in version 2.26.
- get_can_acquire() bool #
Gets the value of the ‘can-acquire’ property. This property is
True
if it is generally possible to acquire the permission by callingacquire()
.Added in version 2.26.
- get_can_release() bool #
Gets the value of the ‘can-release’ property. This property is
True
if it is generally possible to release the permission by callingrelease()
.Added in version 2.26.
- impl_update(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 aPermission
implementation.GObject notify signals are generated, as appropriate.
Added in version 2.26.
- 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(cancellable: Cancellable | None = 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
get_can_release()
before calling this function.If the permission is released then
True
is returned. Otherwise,False
is returned anderror
is set appropriately.This call is blocking, likely for a very long time (in the case that user interaction is required). See
release_async()
for the non-blocking version.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
- release_async(cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) None #
Attempts to release the permission represented by
permission
.This is the first half of the asynchronous version of
release()
.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
callback – the
AsyncReadyCallback
to call when doneuser_data – the user data to pass to
callback
- release_finish(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
release()
.Added in version 2.26.
- Parameters:
result – the
AsyncResult
given to theAsyncReadyCallback
Properties#
Virtual Methods#
- class Permission
- do_acquire(cancellable: Cancellable | None = 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
get_can_acquire()
before calling this function.If the permission is acquired then
True
is returned. Otherwise,False
is returned anderror
is set appropriately.This call is blocking, likely for a very long time (in the case that user interaction is required). See
acquire_async()
for the non-blocking version.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
- do_acquire_async(cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) None #
Attempts to acquire the permission represented by
permission
.This is the first half of the asynchronous version of
acquire()
.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
callback – the
AsyncReadyCallback
to call when doneuser_data – the user data to pass to
callback
- do_acquire_finish(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
acquire()
.Added in version 2.26.
- Parameters:
result – the
AsyncResult
given to theAsyncReadyCallback
- do_release(cancellable: Cancellable | None = 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
get_can_release()
before calling this function.If the permission is released then
True
is returned. Otherwise,False
is returned anderror
is set appropriately.This call is blocking, likely for a very long time (in the case that user interaction is required). See
release_async()
for the non-blocking version.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
- do_release_async(cancellable: Cancellable | None = None, callback: Callable[[...], None] | None = None, *user_data: Any) None #
Attempts to release the permission represented by
permission
.This is the first half of the asynchronous version of
release()
.Added in version 2.26.
- Parameters:
cancellable – a
Cancellable
, orNone
callback – the
AsyncReadyCallback
to call when doneuser_data – the user data to pass to
callback
- do_release_finish(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
release()
.Added in version 2.26.
- Parameters:
result – the
AsyncResult
given to theAsyncReadyCallback