Class Permission

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gio.Permission
All Implemented Interfaces:
Proxy
Direct Known Subclasses:
Permission.Permission$Impl, SimplePermission
@Generated("org.javagi.JavaGI") public abstract class Permission extends GObject

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

  • Constructor Details

    • Permission

      public Permission(MemorySegment address)
      Create a Permission instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • Permission

      public Permission()
      Create a new Permission.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the Permission class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected Permission asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • acquire

      public boolean acquire(@Nullable Cancellable cancellable) throws GErrorException

      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:
      GErrorException - see GError
      Since:
      2.26

    • acquireAsync

      public void acquireAsync(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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
      Since:
      2.26

    • acquireFinish

      public boolean acquireFinish(AsyncResult result) throws GErrorException

      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:
      GErrorException - see GError
      Since:
      2.26

    • 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 this Permission represents the permission to perform.
      Returns:
      the value of the 'allowed' property
      Since:
      2.26

    • 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
      Since:
      2.26

    • 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
      Since:
      2.26

    • implUpdate

      public void implUpdate(boolean allowed, boolean canAcquire, boolean canRelease)

      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
      canAcquire - the new value for the 'can-acquire' property
      canRelease - the new value for the 'can-release' property
      Since:
      2.26

    • release

      public boolean release(@Nullable Cancellable cancellable) throws GErrorException

      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:
      GErrorException - see GError
      Since:
      2.26

    • releaseAsync

      public void releaseAsync(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)

      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
      Since:
      2.26

    • releaseFinish

      public boolean releaseFinish(AsyncResult result) throws GErrorException

      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:
      GErrorException - see GError
      Since:
      2.26