Package ch.bailu.gtk.gio

Class Permission

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gio.Permission
All Implemented Interfaces:
PointerInterface
Direct Known Subclasses:
SimplePermission
public class Permission 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 #GSettings 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.

https://docs.gtk.org/gio/class.Permission.html

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • acquire

      public boolean acquire(@Nullable Cancellable cancellable) throws AllocationError
      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.
      Parameters:
      cancellable - a #GCancellable, or %NULL
      Returns:
      %TRUE if the permission was successfully acquired
      Throws:
      AllocationError

    • acquireAsync

      public void acquireAsync(@Nullable Cancellable cancellable, Permission.OnAsyncReadyCallback callback, @Nullable Pointer user_data)
      Attempts to acquire the permission represented by @permission.

      This is the first half of the asynchronous version of
      g_permission_acquire().
      Parameters:
      cancellable - a #GCancellable, or %NULL
      callback - the #GAsyncReadyCallback to call when done
      user_data - the user data to pass to @callback

    • acquireFinish

      public boolean acquireFinish(@Nonnull AsyncResult result) throws AllocationError
      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().
      Parameters:
      result - the #GAsyncResult given to the #GAsyncReadyCallback
      Returns:
      %TRUE if the permission was successfully acquired
      Throws:
      AllocationError

    • getAllowed

      public boolean getAllowed()
      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.
      Returns:
      the value of the 'allowed' property

    • getCanAcquire

      public boolean getCanAcquire()
      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().
      Returns:
      the value of the 'can-acquire' property

    • getCanRelease

      public boolean getCanRelease()
      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().
      Returns:
      the value of the 'can-release' property

    • implUpdate

      public void implUpdate(boolean allowed, boolean can_acquire, boolean 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.
      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

      public boolean release(@Nullable Cancellable cancellable) throws AllocationError
      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.
      Parameters:
      cancellable - a #GCancellable, or %NULL
      Returns:
      %TRUE if the permission was successfully released
      Throws:
      AllocationError

    • releaseAsync

      public void releaseAsync(@Nullable Cancellable cancellable, Permission.OnAsyncReadyCallback callback, @Nullable Pointer user_data)
      Attempts to release the permission represented by @permission.

      This is the first half of the asynchronous version of
      g_permission_release().
      Parameters:
      cancellable - a #GCancellable, or %NULL
      callback - the #GAsyncReadyCallback to call when done
      user_data - the user data to pass to @callback

    • releaseFinish

      public boolean releaseFinish(@Nonnull AsyncResult result) throws AllocationError
      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().
      Parameters:
      result - the #GAsyncResult given to the #GAsyncReadyCallback
      Returns:
      %TRUE if the permission was successfully released
      Throws:
      AllocationError

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()