TelepathyGLib.DebugClient¶

Subclasses:: None

Methods¶

Inherited:: TelepathyGLib.Proxy (11), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_feature_quark_core` ()
class	`init_known_interfaces` ()
class	`new` (dbus, unique_name)
	`get_messages_async` (callback, *user_data)
	`get_messages_finish` (result)
	`is_enabled` ()
	`set_enabled_async` (enabled, callback, *user_data)
	`set_enabled_finish` (result)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: TelepathyGLib.Proxy (5)

Name	Type	Flags	Short Description
`enabled`	`bool`	r	Enabled

Signals¶

Inherited:: TelepathyGLib.Proxy (2), GObject.Object (1)

Name	Short Description
`new-debug-message`	Emitted when a `TelepathyGLib.DebugMessage` is generated if the `TelepathyGLib.DebugMessage` `:enabled` property is set to `True`.

Fields¶

Inherited:: TelepathyGLib.Proxy (2), GObject.Object (1)

Class Details¶

class TelepathyGLib.DebugClient(**kwargs)¶

Bases:: TelepathyGLib.Proxy
Abstract:: No
Structure:: TelepathyGLib.DebugClientClass

A proxy object for the debug interface of a Telepathy component.

New in version 0.19.0.

classmethod get_feature_quark_core()¶

Return type:: int

classmethod init_known_interfaces()¶: Ensure that the known interfaces for TelepathyGLib.DebugClient have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument %TP_TYPE_DEBUG_CLIENT.

New in version 0.19.0.

classmethod new(dbus, unique_name)¶

Parameters:

dbus (TelepathyGLib.DBusDaemon) – a D-Bus daemon; may not be None
unique_name (str) – the unique name of the process to be debugged; may not be None or a well-known name

Raises:

GLib.Error

Returns:

a new debug client proxy, or None on invalid arguments

Return type:

TelepathyGLib.DebugClient

New in version 0.19.0.

get_messages_async(callback, *user_data)¶

Parameters:

callback (Gio.AsyncReadyCallback or None) – callback to call when the messages have been retrieved
user_data (object or None) – data to pass to callback

Retrieve buffered messages from self. Once callback is called, use TelepathyGLib.DebugClient.get_messages_finish() to retrieve the TelepathyGLib.DebugMessage objects.

New in version 0.19.0.

get_messages_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: a GLib.PtrArray of TelepathyGLib.DebugMessage, free with g_ptr_array_unref()
Return type:: [TelepathyGLib.DebugMessage]

Finishes TelepathyGLib.DebugClient.set_enabled_async().

New in version 0.19.0.

is_enabled()¶

Returns:: the value of TelepathyGLib.DebugClient :enabled property
Return type:: bool

Return the TelepathyGLib.DebugClient :enabled property

New in version 0.19.0.

set_enabled_async(enabled, callback, *user_data)¶

Parameters:

enabled (bool) – True if debug messages should be published on the bus, False otherwise
callback (Gio.AsyncReadyCallback or None) – a callback to call when the request is satisfied
user_data (object or None) – data to pass to callback

Enable or disable publishing of debug messages on the bus by the component owning self's bus name.

New in version 0.19.0.

set_enabled_finish(result)¶

Parameters:: result (Gio.AsyncResult) – a Gio.AsyncResult
Raises:: GLib.Error
Returns:: True, if the operation suceeded, False otherwise
Return type:: bool

Finishes TelepathyGLib.DebugClient.set_enabled_async().

New in version 0.19.0.

Signal Details¶

TelepathyGLib.DebugClient.signals.new_debug_message(debug_client, message)¶

Signal Name:

new-debug-message

Flags:

RUN_LAST

Parameters:

debug_client (TelepathyGLib.DebugClient) – The object which received the signal
message (TelepathyGLib.DebugMessage) – a TelepathyGLib.DebugMessage

Emitted when a TelepathyGLib.DebugMessage is generated if the TelepathyGLib.DebugMessage :enabled property is set to True.

New in version 0.19.0.

Property Details¶

TelepathyGLib.DebugClient.props.enabled¶

Name:: enabled
Type:: bool
Default Value:: False
Flags:: READABLE

True if debug messages are published on the bus.

This property is meaningless until the %TP_DEBUG_CLIENT_FEATURE_CORE feature has been prepared.

New in version 0.19.0.