class: Permission

[20:7] extends: 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 [class@Gio.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.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Permission (Handle = null)

  Creates a new Permission by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• acquire (object cancellable)

  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.

  • @p cancellable is a #GCancellable, or %NULL.

• acquire_finish (object result)

  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().

  • @p result is the #GAsyncResult given to the #GAsyncReadyCallback.

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

• 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 g_permission_acquire().

• 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 g_permission_release().

• impl_update (bool allowed, bool can_acquire, bool 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.

  • @p allowed is the new value for the 'allowed' property.
  • @p can_acquire is the new value for the 'can-acquire' property.
  • @p can_release is the new value for the 'can-release' property.
  • @r None.

• release (object cancellable)

  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.

  • @p cancellable is a #GCancellable, or %NULL.

• release_finish (object result)

  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().

  • @p result is the #GAsyncResult given to the #GAsyncReadyCallback.

class: PermissionMeta

[226:14] static extends: object

Generated metadata helpers for Permission class surfaces.

Methods

• properties ()

  Returns property metadata for Permission.

  • @r A list.