Gio.Permission

g GObject.Object GObject.Object Gio.Permission Gio.Permission GObject.Object->Gio.Permission

Subclasses:Gio.SimplePermission

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
  acquire (cancellable)
  acquire_async (cancellable, callback, *user_data)
  acquire_finish (result)
  get_allowed ()
  get_can_acquire ()
  get_can_release ()
  impl_update (allowed, can_acquire, can_release)
  release (cancellable)
  release_async (cancellable, callback, *user_data)
  release_finish (result)

Virtual Methods

Inherited:GObject.Object (7)
  do_acquire (cancellable)
  do_acquire_async (cancellable, callback, *user_data)
  do_acquire_finish (result)
  do_release (cancellable)
  do_release_async (cancellable, callback, *user_data)
  do_release_finish (result)

Properties

Name Type Flags Short Description
allowed bool r If the caller is allowed to perform the action
can-acquire bool r If calling Gio.Permission.acquire() makes sense
can-release bool r If calling Gio.Permission.release() makes sense

Signals

Inherited:GObject.Object (1)

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent_instance GObject.Object r  

Class Details

class Gio.Permission(**kwargs)
Bases:GObject.Object
Abstract:Yes
Structure:Gio.PermissionClass

A Gio.Permission 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 Gio.Permission might represent the ability for the user to write to a Gio.Settings object. This Gio.Permission 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.

acquire(cancellable)[source]
Parameters:cancellable (Gio.Cancellable or None) – a Gio.Cancellable, or None
Raises:GLib.Error
Returns:True if the permission was successfully acquired
Return type:bool

Attempts to acquire the permission represented by self.

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 Gio.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 Gio.Permission.acquire_async() for the non-blocking version.

New in version 2.26.

acquire_async(cancellable, callback, *user_data)[source]
Parameters:

Attempts to acquire the permission represented by self.

This is the first half of the asynchronous version of Gio.Permission.acquire().

New in version 2.26.

acquire_finish(result)[source]
Parameters:result (Gio.AsyncResult) – the Gio.AsyncResult given to the Gio.AsyncReadyCallback
Raises:GLib.Error
Returns:True if the permission was successfully acquired
Return type:bool

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

This is the second half of the asynchronous version of Gio.Permission.acquire().

New in version 2.26.

get_allowed()[source]
Returns:the value of the ‘allowed’ property
Return type:bool

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

New in version 2.26.

get_can_acquire()[source]
Returns:the value of the ‘can-acquire’ property
Return type:bool

Gets the value of the ‘can-acquire’ property. This property is True if it is generally possible to acquire the permission by calling Gio.Permission.acquire().

New in version 2.26.

get_can_release()[source]
Returns:the value of the ‘can-release’ property
Return type:bool

Gets the value of the ‘can-release’ property. This property is True if it is generally possible to release the permission by calling Gio.Permission.release().

New in version 2.26.

impl_update(allowed, can_acquire, can_release)[source]
Parameters:
  • allowed (bool) – the new value for the ‘allowed’ property
  • can_acquire (bool) – the new value for the ‘can-acquire’ property
  • can_release (bool) – the new value for the ‘can-release’ property

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

GObject.Object notify signals are generated, as appropriate.

New in version 2.26.

release(cancellable)[source]
Parameters:cancellable (Gio.Cancellable or None) – a Gio.Cancellable, or None
Raises:GLib.Error
Returns:True if the permission was successfully released
Return type:bool

Attempts to release the permission represented by self.

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 Gio.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 Gio.Permission.release_async() for the non-blocking version.

New in version 2.26.

release_async(cancellable, callback, *user_data)[source]
Parameters:

Attempts to release the permission represented by self.

This is the first half of the asynchronous version of Gio.Permission.release().

New in version 2.26.

release_finish(result)[source]
Parameters:result (Gio.AsyncResult) – the Gio.AsyncResult given to the Gio.AsyncReadyCallback
Raises:GLib.Error
Returns:True if the permission was successfully released
Return type:bool

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

This is the second half of the asynchronous version of Gio.Permission.release().

New in version 2.26.

do_acquire(cancellable) virtual
Parameters:cancellable (Gio.Cancellable or None) – a Gio.Cancellable, or None
Returns:True if the permission was successfully acquired
Return type: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 Gio.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 Gio.Permission.acquire_async() for the non-blocking version.

New in version 2.26.

do_acquire_async(cancellable, callback, *user_data) virtual
Parameters:

Attempts to acquire the permission represented by permission.

This is the first half of the asynchronous version of Gio.Permission.acquire().

New in version 2.26.

do_acquire_finish(result) virtual
Parameters:result (Gio.AsyncResult) – the Gio.AsyncResult given to the Gio.AsyncReadyCallback
Returns:True if the permission was successfully acquired
Return type:bool

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

This is the second half of the asynchronous version of Gio.Permission.acquire().

New in version 2.26.

do_release(cancellable) virtual
Parameters:cancellable (Gio.Cancellable or None) – a Gio.Cancellable, or None
Returns:True if the permission was successfully released
Return type: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 Gio.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 Gio.Permission.release_async() for the non-blocking version.

New in version 2.26.

do_release_async(cancellable, callback, *user_data) virtual
Parameters:

Attempts to release the permission represented by permission.

This is the first half of the asynchronous version of Gio.Permission.release().

New in version 2.26.

do_release_finish(result) virtual
Parameters:result (Gio.AsyncResult) – the Gio.AsyncResult given to the Gio.AsyncReadyCallback
Returns:True if the permission was successfully released
Return type:bool

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

This is the second half of the asynchronous version of Gio.Permission.release().

New in version 2.26.

Property Details

Gio.Permission.props.allowed
Name:allowed
Type:bool
Default Value:False
Flags:READABLE

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

Gio.Permission.props.can_acquire
Name:can-acquire
Type:bool
Default Value:False
Flags:READABLE

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

Gio.Permission.props.can_release
Name:can-release
Type:bool
Default Value:False
Flags:READABLE

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