:right-sidebar: True DBusObjectManagerClient =================================================================== .. currentmodule:: gi.repository.Gio .. versionadded:: 2.30 .. class:: DBusObjectManagerClient(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Implemented Interfaces: :class:`~gi.repository.Gio.AsyncInitable`, :class:`~gi.repository.Gio.DBusObjectManager`, :class:`~gi.repository.Gio.Initable` :Constructors: :: DBusObjectManagerClient(**properties) new_finish(res:Gio.AsyncResult) -> Gio.DBusObjectManagerClient new_for_bus_finish(res:Gio.AsyncResult) -> Gio.DBusObjectManagerClient new_for_bus_sync(bus_type:Gio.BusType, flags:Gio.DBusObjectManagerClientFlags, name:str, object_path:str, get_proxy_type_func:Gio.DBusProxyTypeFunc=None, get_proxy_type_user_data=None, cancellable:Gio.Cancellable=None) -> Gio.DBusObjectManagerClient new_sync(connection:Gio.DBusConnection, flags:Gio.DBusObjectManagerClientFlags, name:str=None, object_path:str, get_proxy_type_func:Gio.DBusProxyTypeFunc=None, get_proxy_type_user_data=None, cancellable:Gio.Cancellable=None) -> Gio.DBusObjectManagerClient Constructors ------------ .. rst-class:: interim-class .. class:: DBusObjectManagerClient :no-index: .. classmethod:: new_finish(res: ~gi.repository.Gio.AsyncResult) -> ~gi.repository.Gio.DBusObjectManagerClient Finishes an operation started with :func:`~gi.repository.Gio.DBusObjectManagerClient.new`. .. versionadded:: 2.30 :param res: A :obj:`~gi.repository.Gio.AsyncResult` obtained from the :obj:`~gi.repository.Gio.AsyncReadyCallback` passed to :func:`~gi.repository.Gio.DBusObjectManagerClient.new`. .. classmethod:: new_for_bus_finish(res: ~gi.repository.Gio.AsyncResult) -> ~gi.repository.Gio.DBusObjectManagerClient Finishes an operation started with :func:`~gi.repository.Gio.DBusObjectManagerClient.new_for_bus`. .. versionadded:: 2.30 :param res: A :obj:`~gi.repository.Gio.AsyncResult` obtained from the :obj:`~gi.repository.Gio.AsyncReadyCallback` passed to :func:`~gi.repository.Gio.DBusObjectManagerClient.new_for_bus`. .. classmethod:: new_for_bus_sync(bus_type: ~gi.repository.Gio.BusType, flags: ~gi.repository.Gio.DBusObjectManagerClientFlags, name: str, object_path: str, get_proxy_type_func: ~typing.Callable[[...], type] | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None, *get_proxy_type_user_data: ~typing.Any) -> ~gi.repository.Gio.DBusObjectManagerClient Like :func:`~gi.repository.Gio.DBusObjectManagerClient.new_sync` but takes a :obj:`~gi.repository.Gio.BusType` instead of a :obj:`~gi.repository.Gio.DBusConnection`. This is a synchronous failable constructor - the calling thread is blocked until a reply is received. See :func:`~gi.repository.Gio.DBusObjectManagerClient.new_for_bus` for the asynchronous version. .. versionadded:: 2.30 :param bus_type: A :obj:`~gi.repository.Gio.BusType`. :param flags: Zero or more flags from the :obj:`~gi.repository.Gio.DBusObjectManagerClientFlags` enumeration. :param name: The owner of the control object (unique or well-known name). :param object_path: The object path of the control object. :param get_proxy_type_func: A :obj:`~gi.repository.Gio.DBusProxyTypeFunc` function or :const:`None` to always construct :obj:`~gi.repository.Gio.DBusProxy` proxies. :param cancellable: A :obj:`~gi.repository.Gio.Cancellable` or :const:`None` :param get_proxy_type_user_data: User data to pass to ``get_proxy_type_func``. .. classmethod:: new_sync(connection: ~gi.repository.Gio.DBusConnection, flags: ~gi.repository.Gio.DBusObjectManagerClientFlags, name: str | None, object_path: str, get_proxy_type_func: ~typing.Callable[[...], type] | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None, *get_proxy_type_user_data: ~typing.Any) -> ~gi.repository.Gio.DBusObjectManagerClient Creates a new :obj:`~gi.repository.Gio.DBusObjectManagerClient` object. This is a synchronous failable constructor - the calling thread is blocked until a reply is received. See :func:`~gi.repository.Gio.DBusObjectManagerClient.new` for the asynchronous version. .. versionadded:: 2.30 :param connection: A :obj:`~gi.repository.Gio.DBusConnection`. :param flags: Zero or more flags from the :obj:`~gi.repository.Gio.DBusObjectManagerClientFlags` enumeration. :param name: The owner of the control object (unique or well-known name), or :const:`None` when not using a message bus connection. :param object_path: The object path of the control object. :param get_proxy_type_func: A :obj:`~gi.repository.Gio.DBusProxyTypeFunc` function or :const:`None` to always construct :obj:`~gi.repository.Gio.DBusProxy` proxies. :param cancellable: A :obj:`~gi.repository.Gio.Cancellable` or :const:`None` :param get_proxy_type_user_data: User data to pass to ``get_proxy_type_func``. Methods ------- .. rst-class:: interim-class .. class:: DBusObjectManagerClient :no-index: .. method:: get_connection() -> ~gi.repository.Gio.DBusConnection Gets the :obj:`~gi.repository.Gio.DBusConnection` used by ``manager``. .. versionadded:: 2.30 .. method:: get_flags() -> ~gi.repository.Gio.DBusObjectManagerClientFlags Gets the flags that ``manager`` was constructed with. .. versionadded:: 2.30 .. method:: get_name() -> str Gets the name that ``manager`` is for, or :const:`None` if not a message bus connection. .. versionadded:: 2.30 .. method:: get_name_owner() -> str | None The unique name that owns the name that ``manager`` is for or :const:`None` if no-one currently owns that name. You can connect to the :obj:`~gi.repository.GObject.Object`::notify signal to track changes to the :obj:`~gi.repository.Gio.DBusObjectManagerClient`:name-owner property. .. versionadded:: 2.30 .. method:: new(connection: ~gi.repository.Gio.DBusConnection, flags: ~gi.repository.Gio.DBusObjectManagerClientFlags, name: str, object_path: str, get_proxy_type_func: ~typing.Callable[[...], type] | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None Asynchronously creates a new :obj:`~gi.repository.Gio.DBusObjectManagerClient` object. This is an asynchronous failable constructor. When the result is ready, ``callback`` will be invoked in the [thread-default main context][g-main-context-push-thread-default] of the thread you are calling this method from. You can then call :func:`~gi.repository.Gio.DBusObjectManagerClient.new_finish` to get the result. See :func:`~gi.repository.Gio.DBusObjectManagerClient.new_sync` for the synchronous version. .. versionadded:: 2.30 :param connection: A :obj:`~gi.repository.Gio.DBusConnection`. :param flags: Zero or more flags from the :obj:`~gi.repository.Gio.DBusObjectManagerClientFlags` enumeration. :param name: The owner of the control object (unique or well-known name). :param object_path: The object path of the control object. :param get_proxy_type_func: A :obj:`~gi.repository.Gio.DBusProxyTypeFunc` function or :const:`None` to always construct :obj:`~gi.repository.Gio.DBusProxy` proxies. :param cancellable: A :obj:`~gi.repository.Gio.Cancellable` or :const:`None` :param callback: A :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when the request is satisfied. :param user_data: The data to pass to ``callback``. .. method:: new_for_bus(bus_type: ~gi.repository.Gio.BusType, flags: ~gi.repository.Gio.DBusObjectManagerClientFlags, name: str, object_path: str, get_proxy_type_func: ~typing.Callable[[...], type] | None = None, cancellable: ~gi.repository.Gio.Cancellable | None = None, callback: ~typing.Callable[[...], None] | None = None, *user_data: ~typing.Any) -> None Like :func:`~gi.repository.Gio.DBusObjectManagerClient.new` but takes a :obj:`~gi.repository.Gio.BusType` instead of a :obj:`~gi.repository.Gio.DBusConnection`. This is an asynchronous failable constructor. When the result is ready, ``callback`` will be invoked in the [thread-default main loop][g-main-context-push-thread-default] of the thread you are calling this method from. You can then call :func:`~gi.repository.Gio.DBusObjectManagerClient.new_for_bus_finish` to get the result. See :func:`~gi.repository.Gio.DBusObjectManagerClient.new_for_bus_sync` for the synchronous version. .. versionadded:: 2.30 :param bus_type: A :obj:`~gi.repository.Gio.BusType`. :param flags: Zero or more flags from the :obj:`~gi.repository.Gio.DBusObjectManagerClientFlags` enumeration. :param name: The owner of the control object (unique or well-known name). :param object_path: The object path of the control object. :param get_proxy_type_func: A :obj:`~gi.repository.Gio.DBusProxyTypeFunc` function or :const:`None` to always construct :obj:`~gi.repository.Gio.DBusProxy` proxies. :param cancellable: A :obj:`~gi.repository.Gio.Cancellable` or :const:`None` :param callback: A :obj:`~gi.repository.Gio.AsyncReadyCallback` to call when the request is satisfied. :param user_data: The data to pass to ``callback``. Properties ---------- .. rst-class:: interim-class .. class:: DBusObjectManagerClient :no-index: .. attribute:: props.bus_type :type: ~gi.repository.Gio.BusType If this property is not :const:`~gi.repository.Gio.BusType.NONE`, then :obj:`~gi.repository.Gio.DBusObjectManagerClient`:connection must be :const:`None` and will be set to the :obj:`~gi.repository.Gio.DBusConnection` obtained by calling :func:`~gi.repository.Gio.bus_get` with the value of this property. .. versionadded:: 2.30 .. attribute:: props.connection :type: ~gi.repository.Gio.DBusConnection The :obj:`~gi.repository.Gio.DBusConnection` to use. .. versionadded:: 2.30 .. attribute:: props.flags :type: ~gi.repository.Gio.DBusObjectManagerClientFlags Flags from the :obj:`~gi.repository.Gio.DBusObjectManagerClientFlags` enumeration. .. versionadded:: 2.30 .. attribute:: props.get_proxy_type_destroy_notify :type: None A :obj:`~gi.repository.GLib.DestroyNotify` for the :obj:`~gi.repository.gpointer` user_data in :obj:`~gi.repository.Gio.DBusObjectManagerClient`:get-proxy-type-user-data. .. versionadded:: 2.30 .. attribute:: props.get_proxy_type_func :type: None The :obj:`~gi.repository.Gio.DBusProxyTypeFunc` to use when determining what :obj:`~gi.repository.GObject.Type` to use for interface proxies or :const:`None`. .. versionadded:: 2.30 .. attribute:: props.get_proxy_type_user_data :type: None The :obj:`~gi.repository.gpointer` user_data to pass to :obj:`~gi.repository.Gio.DBusObjectManagerClient`:get-proxy-type-func. .. versionadded:: 2.30 .. attribute:: props.name :type: str The well-known name or unique name that the manager is for. .. versionadded:: 2.30 .. attribute:: props.name_owner :type: str The unique name that owns :obj:`~gi.repository.Gio.DBusObjectManagerClient`:name or :const:`None` if no-one is currently owning the name. Connect to the :obj:`~gi.repository.GObject.Object`::notify signal to track changes to this property. .. versionadded:: 2.30 .. attribute:: props.object_path :type: str The object path the manager is for. .. versionadded:: 2.30 Signals ------- .. rst-class:: interim-class .. class:: DBusObjectManagerClient.signals :no-index: .. method:: interface_proxy_properties_changed(object_proxy: ~gi.repository.Gio.DBusObjectProxy, interface_proxy: ~gi.repository.Gio.DBusProxy, changed_properties: ~gi.repository.GLib.Variant, invalidated_properties: ~typing.Sequence[str]) -> None Emitted when one or more D-Bus properties on proxy changes. The local cache has already been updated when this signal fires. Note that both ``changed_properties`` and ``invalidated_properties`` are guaranteed to never be :const:`None` (either may be empty though). This signal exists purely as a convenience to avoid having to connect signals to all interface proxies managed by ``manager``. This signal is emitted in the [thread-default main context][g-main-context-push-thread-default] that ``manager`` was constructed in. .. versionadded:: 2.30 :param object_proxy: The :obj:`~gi.repository.Gio.DBusObjectProxy` on which an interface has properties that are changing. :param interface_proxy: The :obj:`~gi.repository.Gio.DBusProxy` that has properties that are changing. :param changed_properties: A :obj:`~gi.repository.GLib.Variant` containing the properties that changed (type: ``a{sv}``). :param invalidated_properties: A :const:`None` terminated array of properties that were invalidated. .. method:: interface_proxy_signal(object_proxy: ~gi.repository.Gio.DBusObjectProxy, interface_proxy: ~gi.repository.Gio.DBusProxy, sender_name: str, signal_name: str, parameters: ~gi.repository.GLib.Variant) -> None Emitted when a D-Bus signal is received on ``interface_proxy``. This signal exists purely as a convenience to avoid having to connect signals to all interface proxies managed by ``manager``. This signal is emitted in the [thread-default main context][g-main-context-push-thread-default] that ``manager`` was constructed in. .. versionadded:: 2.30 :param object_proxy: The :obj:`~gi.repository.Gio.DBusObjectProxy` on which an interface is emitting a D-Bus signal. :param interface_proxy: The :obj:`~gi.repository.Gio.DBusProxy` that is emitting a D-Bus signal. :param sender_name: The sender of the signal or NULL if the connection is not a bus connection. :param signal_name: The signal name. :param parameters: A :obj:`~gi.repository.GLib.Variant` tuple with parameters for the signal. Virtual Methods --------------- .. rst-class:: interim-class .. class:: DBusObjectManagerClient :no-index: .. method:: do_interface_proxy_properties_changed(object_proxy: ~gi.repository.Gio.DBusObjectProxy, interface_proxy: ~gi.repository.Gio.DBusProxy, changed_properties: ~gi.repository.GLib.Variant, invalidated_properties: str) -> None Signal class handler for the :obj:`~gi.repository.Gio.DBusObjectManagerClient`::interface-proxy-properties-changed signal. :param object_proxy: :param interface_proxy: :param changed_properties: :param invalidated_properties: .. method:: do_interface_proxy_signal(object_proxy: ~gi.repository.Gio.DBusObjectProxy, interface_proxy: ~gi.repository.Gio.DBusProxy, sender_name: str, signal_name: str, parameters: ~gi.repository.GLib.Variant) -> None Signal class handler for the :obj:`~gi.repository.Gio.DBusObjectManagerClient`::interface-proxy-signal signal. :param object_proxy: :param interface_proxy: :param sender_name: :param signal_name: :param parameters: Fields ------ .. rst-class:: interim-class .. class:: DBusObjectManagerClient :no-index: .. attribute:: parent_instance .. attribute:: priv