Description

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

Uml Diagram

Class initialization

new

:native-object

Create an object using a native object from an object of the same type found elsewhere. See also Gnome::N::TopLevelSupportClass.

multi method new ( N-Object() :$native-object! )

Methods

acquire

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 and $error 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.

method acquire ( N-Object() $cancellable, CArray[N-Error] $err --> Bool )

• $cancellable; a Gnome::Gio::Cancellable, or undefined.

• $err; Error object. When defined, an error can be returned when there is one. Use Pointer when you want to ignore the error. .

Return value; True if the permission was successfully acquired.

acquire-async

Attempts to acquire the permission represented by $permission.

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

method acquire-async ( N-Object() $cancellable, GAsyncReadyCallback &callback, gpointer $user-data )

• $cancellable; a Gnome::Gio::Cancellable, or undefined.

• GAsyncReadyCallback &callback; the Gnome::Gio::T-iotypes to call when done. The function must be specified with the following signature; :( N-Object $source-object, N-Object $res, gpointer $data ).

• $user-data; the user data to pass to $callback.

acquire-finish

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

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

method acquire-finish ( N-Object() $result, CArray[N-Error] $err --> Bool )

• $result; the Gnome::Gio::R-AsyncResult given to the Gnome::Gio::T-iotypes.

• $err; Error object. When defined, an error can be returned when there is one. Use Pointer when you want to ignore the error. .

Return value; True if the permission was successfully acquired.

get-allowed

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.

method get-allowed (--> Bool )

Return value; the value of the 'allowed' property.

get-can-acquire

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

method get-can-acquire (--> Bool )

Return value; the value of the 'can-acquire' property.

get-can-release

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

method get-can-release (--> Bool )

Return value; the value of the 'can-release' property.

impl-update

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

GObject notify signals are generated, as appropriate.

method impl-update ( Bool() $allowed, Bool() $can-acquire, Bool() $can-release )

• $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

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 and $error 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.

method release ( N-Object() $cancellable, CArray[N-Error] $err --> Bool )

• $cancellable; a Gnome::Gio::Cancellable, or undefined.

• $err; Error object. When defined, an error can be returned when there is one. Use Pointer when you want to ignore the error. .

Return value; True if the permission was successfully released.

release-async

Attempts to release the permission represented by $permission.

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

method release-async ( N-Object() $cancellable, GAsyncReadyCallback &callback, gpointer $user-data )

• $cancellable; a Gnome::Gio::Cancellable, or undefined.

• GAsyncReadyCallback &callback; the Gnome::Gio::T-iotypes to call when done. The function must be specified with the following signature; :( N-Object $source-object, N-Object $res, gpointer $data ).

• $user-data; the user data to pass to $callback.

release-finish

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

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

method release-finish ( N-Object() $result, CArray[N-Error] $err --> Bool )

• $result; the Gnome::Gio::R-AsyncResult given to the Gnome::Gio::T-iotypes.

• $err; Error object. When defined, an error can be returned when there is one. Use Pointer when you want to ignore the error. .

Return value; True if the permission was successfully released.