:right-sidebar: True

Settings
===================================================================

.. currentmodule:: gi.repository.Xdp





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


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





A representation of the settings exposed by the portal.

The :obj:`~gi.repository.Xdp.Settings` object is used to access and observe the settings
exposed by xdg-desktop-portal.

It is obtained from :obj:`~gi.repository.Portal.get_settings`\. Call
:obj:`~gi.repository.Settings.read_value` to read a settings value. Connect to
:obj:`~gi.repository.Xdp.Settings.signals.changed` to observe value changes.




Methods
-------

.. rst-class:: interim-class

.. class:: Settings
   :no-index:


   .. method:: read_all_values(namespaces: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.GLib.Variant

      Read all the setting values within ``namespace``\.






      :param namespaces: List of namespaces to filter results by, supports
         simple globbing explained below.

      :param cancellable: a GCancellable or NULL.




   .. method:: read_string(namespace: str, key: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> str

      Read a setting value as unsigned int within ``namespace``\, with ``key``\.






      :param namespace: the namespace of the value.

      :param key: the key of the value.

      :param cancellable: a GCancellable or NULL.




   .. method:: read_uint(namespace: str, key: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> int

      Read a setting value as unsigned int within ``namespace``\, with ``key``\.






      :param namespace: the namespace of the value.

      :param key: the key of the value.

      :param cancellable: a GCancellable or NULL.




   .. method:: read_value(namespace: str, key: str, cancellable: ~gi.repository.Gio.Cancellable | None = None) -> ~gi.repository.GLib.Variant

      Read a setting value within ``namespace``\, with ``key``\.






      :param namespace: the namespace of the value.

      :param key: the key of the value.

      :param cancellable: a GCancellable or NULL.










Signals
-------

.. rst-class:: interim-class

.. class:: Settings.signals
   :no-index:
   

   .. method:: changed(namespace: str, key: str, value: ~gi.repository.GLib.Variant) -> None

      The type of the None singleton.







      :param namespace: the value namespace

      :param key: the value key

      :param value: the value