gio/org.gtkkn.bindings.gio/Permission

Permission

open class Permission(pointer: <Error class: unknown class><<Error class: unknown class>>)

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.

Inheritors

SimplePermission

Constructors

Permission

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

allowed

open val allowed: Boolean

true if the caller currently has permission to perform the action that

canAcquire

open val canAcquire: Boolean

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

canRelease

open val canRelease: Boolean

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

gioPermissionPointer

val gioPermissionPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

acquire

open fun acquire(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Attempts to acquire the permission represented by @permission.

acquireAsync

open fun acquireAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Attempts to acquire the permission represented by @permission.

acquireFinish

open fun acquireFinish(result: AsyncResult): <Error class: unknown class><Boolean>

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

getAllowed

open fun getAllowed(): Boolean

Gets the value of the 'allowed' property. This property is true if the caller currently has permission to perform the action that

getCanAcquire

open fun getCanAcquire(): Boolean

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

getCanRelease

open fun getCanRelease(): Boolean

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

implUpdate

open fun implUpdate(allowed: Boolean, canAcquire: Boolean, canRelease: Boolean)

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.

release

open fun release(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Attempts to release the permission represented by @permission.

releaseAsync

open fun releaseAsync(cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Attempts to release the permission represented by @permission.

releaseFinish

open fun releaseFinish(result: AsyncResult): <Error class: unknown class><Boolean>

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