:right-sidebar: True

DBusInterfaceInfo
===================================================================

.. currentmodule:: gi.repository.Gio


.. versionadded:: 2.26




.. class:: DBusInterfaceInfo(*args, **kwargs)
   :no-contents-entry:






Information about a D-Bus interface.




Methods
-------

.. rst-class:: interim-class

.. class:: DBusInterfaceInfo
   :no-index:


   .. method:: cache_build() -> None

      Builds a lookup-cache to speed up
      :func:`~gi.repository.Gio.DBusInterfaceInfo.lookup_method`,
      :func:`~gi.repository.Gio.DBusInterfaceInfo.lookup_signal` and
      :func:`~gi.repository.Gio.DBusInterfaceInfo.lookup_property`.

      If this has already been called with ``info``\, the existing cache is
      used and its use count is increased.

      Note that ``info`` cannot be modified until
      :func:`~gi.repository.Gio.DBusInterfaceInfo.cache_release` is called.


      .. versionadded:: 2.30








   .. method:: cache_release() -> None

      Decrements the usage count for the cache for ``info`` built by
      :func:`~gi.repository.Gio.DBusInterfaceInfo.cache_build` (if any) and frees the
      resources used by the cache if the usage count drops to zero.


      .. versionadded:: 2.30








   .. method:: generate_xml(indent: int, string_builder: ~gi.repository.GLib.String) -> None

      Appends an XML representation of ``info`` (and its children) to ``string_builder``\.

      This function is typically used for generating introspection XML
      documents at run-time for handling the
      ``org.freedesktop.DBus.Introspectable.Introspect``
      method.


      .. versionadded:: 2.26





      :param indent: Indentation level.

      :param string_builder: A :obj:`~gi.repository.GLib.String` to to append XML data to.




   .. method:: lookup_method(name: str) -> ~gi.repository.Gio.DBusMethodInfo | None

      Looks up information about a method.

      The cost of this function is O(n) in number of methods unless
      :func:`~gi.repository.Gio.DBusInterfaceInfo.cache_build` has been used on ``info``\.


      .. versionadded:: 2.26





      :param name: A D-Bus method name (typically in CamelCase)




   .. method:: lookup_property(name: str) -> ~gi.repository.Gio.DBusPropertyInfo | None

      Looks up information about a property.

      The cost of this function is O(n) in number of properties unless
      :func:`~gi.repository.Gio.DBusInterfaceInfo.cache_build` has been used on ``info``\.


      .. versionadded:: 2.26





      :param name: A D-Bus property name (typically in CamelCase).




   .. method:: lookup_signal(name: str) -> ~gi.repository.Gio.DBusSignalInfo | None

      Looks up information about a signal.

      The cost of this function is O(n) in number of signals unless
      :func:`~gi.repository.Gio.DBusInterfaceInfo.cache_build` has been used on ``info``\.


      .. versionadded:: 2.26





      :param name: A D-Bus signal name (typically in CamelCase)














Fields
------

.. rst-class:: interim-class

.. class:: DBusInterfaceInfo
   :no-index:
   

   .. attribute:: annotations

      A pointer to a :const:`None`-terminated array of pointers to :obj:`~gi.repository.Gio.DBusAnnotationInfo` structures or :const:`None` if there are no annotations.






   .. attribute:: methods

      A pointer to a :const:`None`-terminated array of pointers to :obj:`~gi.repository.Gio.DBusMethodInfo` structures or :const:`None` if there are no methods.






   .. attribute:: name

      The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties".






   .. attribute:: properties

      A pointer to a :const:`None`-terminated array of pointers to :obj:`~gi.repository.Gio.DBusPropertyInfo` structures or :const:`None` if there are no properties.






   .. attribute:: ref_count

      The reference count or -1 if statically allocated.






   .. attribute:: signals

      A pointer to a :const:`None`-terminated array of pointers to :obj:`~gi.repository.Gio.DBusSignalInfo` structures or :const:`None` if there are no signals.