GPermission

typedef struct _GPermission GPermission;

GPermission is an opaque data structure and can only be accessed using the following functions.

g_permission_get_allowed ()

gboolean            g_permission_get_allowed            (GPermission *permission);

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.

Since 2.26

g_permission_get_can_acquire ()

gboolean            g_permission_get_can_acquire        (GPermission *permission);

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

Since 2.26

g_permission_get_can_release ()

gboolean            g_permission_get_can_release        (GPermission *permission);

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

Since 2.26

g_permission_acquire ()

gboolean            g_permission_acquire                (GPermission *permission,
                                                         GCancellable *cancellable,
                                                         GError **error);

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 g_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 g_permission_acquire_async() for the non-blocking version.

Since 2.26

g_permission_acquire_async ()

void                g_permission_acquire_async          (GPermission *permission,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Attempts to acquire the permission represented by permission.

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

Since 2.26

g_permission_acquire_finish ()

gboolean            g_permission_acquire_finish         (GPermission *permission,
                                                         GAsyncResult *result,
                                                         GError **error);

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

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

Since 2.26

g_permission_release ()

gboolean            g_permission_release                (GPermission *permission,
                                                         GCancellable *cancellable,
                                                         GError **error);

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 g_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 g_permission_release_async() for the non-blocking version.

Since 2.26

g_permission_release_async ()

void                g_permission_release_async          (GPermission *permission,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Attempts to release the permission represented by permission.

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

Since 2.26

g_permission_release_finish ()

gboolean            g_permission_release_finish         (GPermission *permission,
                                                         GAsyncResult *result,
                                                         GError **error);

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

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

Since 2.26

g_permission_impl_update ()

void                g_permission_impl_update            (GPermission *permission,
                                                         gboolean allowed,
                                                         gboolean can_acquire,
                                                         gboolean can_release);

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

GObject notify signals are generated, as appropriate.

Since 2.26

The "allowed" property

  "allowed"                  gboolean              : Read

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

Default value: FALSE

The "can-acquire" property

  "can-acquire"              gboolean              : Read

TRUE if it is generally possible to acquire the permission by calling g_permission_acquire().

Default value: FALSE

The "can-release" property

  "can-release"              gboolean              : Read

TRUE if it is generally possible to release the permission by calling g_permission_release().

Default value: FALSE