:right-sidebar: True

Permission
===================================================================

.. currentmodule:: gi.repository.Gio





.. class:: Permission(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`


Subclasses: :class:`~gi.repository.Gio.SimplePermission`




:Constructors:

::

    Permission(**properties)





Methods
-------

.. rst-class:: interim-class

.. class:: Permission
   :no-index:


   .. method:: acquire(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool

      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 :func:`~gi.repository.Gio.Permission.get_can_acquire` before calling
      this function.

      If the permission is acquired then :const:`True` is returned.  Otherwise,
      :const:`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 :func:`~gi.repository.Gio.Permission.acquire_async` for
      the non-blocking version.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`





   .. method:: acquire_async(cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Attempts to acquire the permission represented by ``permission``.

      This is the first half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.acquire`.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`


      :param callback: the :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when done


      :param user_data: the user data to pass to ``callback``





   .. method:: acquire_finish(result: ~gi.repository.Gio.AsyncResult) -> bool

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

      This is the second half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.acquire`.



      .. versionadded:: 2.26





      :param result: the :obj:`~gi.repository.Gio.AsyncResult` given to the :obj:`~gi.repository.Gio.AsyncReadyCallback`





   .. method:: get_allowed() -> bool

      Gets the value of the 'allowed' property.  This property is :const:`True` if
      the caller currently has permission to perform the action that
      ``permission`` represents the permission to perform.



      .. versionadded:: 2.26








   .. method:: get_can_acquire() -> bool

      Gets the value of the 'can-acquire' property.  This property is :const:`True`
      if it is generally possible to acquire the permission by calling
      :func:`~gi.repository.Gio.Permission.acquire`.



      .. versionadded:: 2.26








   .. method:: get_can_release() -> bool

      Gets the value of the 'can-release' property.  This property is :const:`True`
      if it is generally possible to release the permission by calling
      :func:`~gi.repository.Gio.Permission.release`.



      .. versionadded:: 2.26








   .. method:: impl_update(allowed: bool, can_acquire: bool, can_release: bool) -> None

      This function is called by the :obj:`~gi.repository.Gio.Permission` implementation to update
      the properties of the permission.  You should never call this
      function except from a :obj:`~gi.repository.Gio.Permission` implementation.

      GObject notify signals are generated, as appropriate.



      .. versionadded:: 2.26





      :param allowed: the new value for the 'allowed' property


      :param can_acquire: the new value for the 'can-acquire' property


      :param can_release: the new value for the 'can-release' property





   .. method:: release(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool

      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 :func:`~gi.repository.Gio.Permission.get_can_release` before calling
      this function.

      If the permission is released then :const:`True` is returned.  Otherwise,
      :const:`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 :func:`~gi.repository.Gio.Permission.release_async` for
      the non-blocking version.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`





   .. method:: release_async(cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Attempts to release the permission represented by ``permission``.

      This is the first half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.release`.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`


      :param callback: the :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when done


      :param user_data: the user data to pass to ``callback``





   .. method:: release_finish(result: ~gi.repository.Gio.AsyncResult) -> bool

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

      This is the second half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.release`.



      .. versionadded:: 2.26





      :param result: the :obj:`~gi.repository.Gio.AsyncResult` given to the :obj:`~gi.repository.Gio.AsyncReadyCallback`









Properties
----------

.. rst-class:: interim-class

.. class:: Permission
   :no-index:
   

   .. attribute:: props.allowed
      :type: bool

      :const:`True` if the caller currently has permission to perform the action that
      ``permission`` represents the permission to perform.







   .. attribute:: props.can_acquire
      :type: bool

      :const:`True` if it is generally possible to acquire the permission by calling
      :func:`~gi.repository.Gio.Permission.acquire`.







   .. attribute:: props.can_release
      :type: bool

      :const:`True` if it is generally possible to release the permission by calling
      :func:`~gi.repository.Gio.Permission.release`.













Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: Permission
   :no-index:
   

   .. method:: do_acquire(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool

      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 :func:`~gi.repository.Gio.Permission.get_can_acquire` before calling
      this function.

      If the permission is acquired then :const:`True` is returned.  Otherwise,
      :const:`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 :func:`~gi.repository.Gio.Permission.acquire_async` for
      the non-blocking version.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`





   .. method:: do_acquire_async(cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Attempts to acquire the permission represented by ``permission``.

      This is the first half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.acquire`.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`


      :param callback: the :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when done


      :param user_data: the user data to pass to ``callback``





   .. method:: do_acquire_finish(result: ~gi.repository.Gio.AsyncResult) -> bool

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

      This is the second half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.acquire`.



      .. versionadded:: 2.26





      :param result: the :obj:`~gi.repository.Gio.AsyncResult` given to the :obj:`~gi.repository.Gio.AsyncReadyCallback`





   .. method:: do_release(cancellable: ~gi.repository.Gio.Cancellable | None = None) -> bool

      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 :func:`~gi.repository.Gio.Permission.get_can_release` before calling
      this function.

      If the permission is released then :const:`True` is returned.  Otherwise,
      :const:`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 :func:`~gi.repository.Gio.Permission.release_async` for
      the non-blocking version.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`





   .. method:: do_release_async(cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None

      Attempts to release the permission represented by ``permission``.

      This is the first half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.release`.



      .. versionadded:: 2.26





      :param cancellable: a :obj:`~gi.repository.Gio.Cancellable`, or :const:`None`


      :param callback: the :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when done


      :param user_data: the user data to pass to ``callback``





   .. method:: do_release_finish(result: ~gi.repository.Gio.AsyncResult) -> bool

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

      This is the second half of the asynchronous version of
      :func:`~gi.repository.Gio.Permission.release`.



      .. versionadded:: 2.26





      :param result: the :obj:`~gi.repository.Gio.AsyncResult` given to the :obj:`~gi.repository.Gio.AsyncReadyCallback`









Fields
------

.. rst-class:: interim-class

.. class:: Permission
   :no-index:
   

   .. attribute:: parent_instance

      






   .. attribute:: priv