Class: Gio::Permission

Inherits:

Object

• Object
• Gio::Permission

Defined in:

(unknown)

Direct Known Subclasses

SimplePermission

Instance Method Summary

• #acquire(cancellable) ⇒ Boolean

  Attempts to acquire the permission represented by permission.

• #acquire_async(cancellable, callback, user_data) ⇒ nil

  Attempts to acquire the permission represented by permission.

• #acquire_finish(result) ⇒ Boolean

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

• #allowed ⇒ Boolean

  Gets the value of the 'allowed' property.

• #allowed=(allowed) ⇒ Boolean

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

• #allowed? ⇒ Boolean

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

• #can_acquire ⇒ Boolean

  Gets the value of the 'can-acquire' property.

• #can_acquire=(can_acquire) ⇒ Boolean

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

• #can_acquire? ⇒ Boolean

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

• #can_release ⇒ Boolean

  Gets the value of the 'can-release' property.

• #can_release=(can_release) ⇒ Boolean

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

• #can_release? ⇒ Boolean

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

• #impl_update(allowed, can_acquire, can_release) ⇒ nil

  This function is called by the #GPermission implementation to update the properties of the permission.

• #release(cancellable) ⇒ Boolean

  Attempts to release the permission represented by permission.

• #release_async(cancellable, callback, user_data) ⇒ nil

  Attempts to release the permission represented by permission.

• #release_finish(result) ⇒ Boolean

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

Instance Method Details

#acquire(cancellable) ⇒ Boolean

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 (Gio::Cancellable) —

  a #GCancellable, or nil

Returns:

• (Boolean) —

  true if the permission was successfully acquired

#acquire_async(cancellable, callback, user_data) ⇒ nil

Attempts to acquire the permission represented by permission.

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

Parameters:

• cancellable (Gio::Cancellable) —

  a #GCancellable, or nil

• callback (Gio::AsyncReadyCallback) —

  the GAsync::ReadyCallback to call when done

• user_data (GObject) —

  the user data to pass to callback

Returns:

• (nil)

#acquire_finish(result) ⇒ Boolean

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 (Gio::AsyncResult) —

  the GAsync::Result given to the #GAsyncReadyCallback

Returns:

• (Boolean) —

  true if the permission was successfully acquired

#allowed ⇒ Boolean

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:

• (Boolean) —

  the value of the 'allowed' property

#allowed=(allowed) ⇒ Boolean

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

Parameters:

• allowed (Boolean)

Returns:

• (Boolean) —

  allowed

• (Boolean) —

  allowed

#allowed? ⇒ Boolean

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

Returns:

• (Boolean) —

  allowed

#can_acquire ⇒ 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().

Returns:

• (Boolean) —

  the value of the 'can-acquire' property

#can_acquire=(can_acquire) ⇒ Boolean

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

Parameters:

• can_acquire (Boolean)

Returns:

• (Boolean) —

  can-acquire

• (Boolean) —

  can-acquire

#can_acquire? ⇒ Boolean

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

Returns:

• (Boolean) —

  can-acquire

#can_release ⇒ 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().

Returns:

• (Boolean) —

  the value of the 'can-release' property

#can_release=(can_release) ⇒ Boolean

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

Parameters:

• can_release (Boolean)

Returns:

• (Boolean) —

  can-release

• (Boolean) —

  can-release

#can_release? ⇒ Boolean

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

Returns:

• (Boolean) —

  can-release

#impl_update(allowed, can_acquire, can_release) ⇒ nil

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 (Boolean) —

  the new value for the 'allowed' property

• can_acquire (Boolean) —

  the new value for the 'can-acquire' property

• can_release (Boolean) —

  the new value for the 'can-release' property

Returns:

• (nil)

#release(cancellable) ⇒ Boolean

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 (Gio::Cancellable) —

  a #GCancellable, or nil

Returns:

• (Boolean) —

  true if the permission was successfully released

#release_async(cancellable, callback, user_data) ⇒ nil

Attempts to release the permission represented by permission.

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

Parameters:

• cancellable (Gio::Cancellable) —

  a #GCancellable, or nil

• callback (Gio::AsyncReadyCallback) —

  the GAsync::ReadyCallback to call when done

• user_data (GObject) —

  the user data to pass to callback

Returns:

• (nil)

#release_finish(result) ⇒ Boolean

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 (Gio::AsyncResult) —

  the GAsync::Result given to the #GAsyncReadyCallback

Returns:

• (Boolean) —

  true if the permission was successfully released