telepathy-glib API Reference Manual: TpLogger

TpLogger

TpLogger — proxy object on the logger

Functions

TpLogger *	tp_logger_dup ()
TpProxyPendingCall *	tp_cli_logger_call_add_favourite_contact ()
TpProxyPendingCall *	tp_cli_logger_call_clear ()
TpProxyPendingCall *	tp_cli_logger_call_clear_account ()
TpProxyPendingCall *	tp_cli_logger_call_clear_entity ()
TpProxyPendingCall *	tp_cli_logger_call_get_favourite_contacts ()
TpProxyPendingCall *	tp_cli_logger_call_remove_favourite_contact ()
void	(*tp_cli_logger_callback_for_add_favourite_contact) ()
void	(*tp_cli_logger_callback_for_clear) ()
void	(*tp_cli_logger_callback_for_clear_account) ()
void	(*tp_cli_logger_callback_for_clear_entity) ()
void	(*tp_cli_logger_callback_for_get_favourite_contacts) ()
void	(*tp_cli_logger_callback_for_remove_favourite_contact) ()
TpProxySignalConnection *	tp_cli_logger_connect_to_favourite_contacts_changed ()
void	(*tp_cli_logger_signal_callback_favourite_contacts_changed) ()

Types and Values

struct	TpLogger
struct	TpLoggerClass

Object Hierarchy

    GObject
    ╰── TpProxy
        ╰── TpLogger

Includes

#include <telepathy-glib/telepathy-glib.h>

Description

TpLogger is a TpProxy subclass on the telepathy logger.

Functions

tp_logger_dup ()

TpLogger *
tp_logger_dup (void);

Returns the default TpClientFactory's TpLogger. It will use tp_client_factory_dup(), print a warning and return NULL if it fails.

Returns

a reference on a TpLogger singleton.

[transfer full]

Since 0.99.8

tp_cli_logger_call_add_favourite_contact ()

TpProxyPendingCall *
tp_cli_logger_call_add_favourite_contact
                               (TpLogger *proxy,
                                gint timeout_ms,
                                const gchar *in_Account,
                                const gchar *in_Identifier,
                                tp_cli_logger_callback_for_add_favourite_contact callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a AddFavouriteContact method call.

Add a contact's designation as a favourite.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Account	Used to pass an 'in' argument: The object path for the TpAccount to which the contact belongs
in_Identifier	Used to pass an 'in' argument: The favourite contact's identifier
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_logger_call_clear ()

TpProxyPendingCall *
tp_cli_logger_call_clear (TpLogger *proxy,
                          gint timeout_ms,
                          tp_cli_logger_callback_for_clear callback,
                          gpointer user_data,
                          GDestroyNotify destroy,
                          GObject *weak_object);

Start a Clear method call.

Clear all the logs. This will not erase the favourite contacts.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_logger_call_clear_account ()

TpProxyPendingCall *
tp_cli_logger_call_clear_account (TpLogger *proxy,
                                  gint timeout_ms,
                                  const gchar *in_Account,
                                  tp_cli_logger_callback_for_clear_account callback,
                                  gpointer user_data,
                                  GDestroyNotify destroy,
                                  GObject *weak_object);

Start a ClearAccount method call.

Clear all logs stored for specified account.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Account	Used to pass an 'in' argument: The object path for the TpAccount in which logs will be cleared.
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_logger_call_clear_entity ()

TpProxyPendingCall *
tp_cli_logger_call_clear_entity (TpLogger *proxy,
                                 gint timeout_ms,
                                 const gchar *in_Account,
                                 const gchar *in_Identifier,
                                 gint in_Type,
                                 tp_cli_logger_callback_for_clear_entity callback,
                                 gpointer user_data,
                                 GDestroyNotify destroy,
                                 GObject *weak_object);

Start a ClearEntity method call.

Clear all logs stored for discussions with entity in account.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Account	Used to pass an 'in' argument: The object path for the TpAccount in which logs will be cleared.
in_Identifier	Used to pass an 'in' argument: The entity identifier.
in_Type	Used to pass an 'in' argument: The entity type, should be one of TP_ENTITY_TYPE_CONTACT (1) or TP_ENTITY_TYPE_ROOM (2).
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_logger_call_get_favourite_contacts ()

TpProxyPendingCall *
tp_cli_logger_call_get_favourite_contacts
                               (TpLogger *proxy,
                                gint timeout_ms,
                                tp_cli_logger_callback_for_get_favourite_contacts callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a GetFavouriteContacts method call.

Returns the favourite contacts.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_logger_call_remove_favourite_contact ()

TpProxyPendingCall *
tp_cli_logger_call_remove_favourite_contact
                               (TpLogger *proxy,
                                gint timeout_ms,
                                const gchar *in_Account,
                                const gchar *in_Identifier,
                                tp_cli_logger_callback_for_remove_favourite_contact callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object);

Start a RemoveFavouriteContact method call.

Remove a contact's designation as a favourite.

Parameters

proxy	the TpProxy
timeout_ms	the timeout in milliseconds, or -1 to use the default
in_Account	Used to pass an 'in' argument: The object path for the TpAccount to which the contact belongs
in_Identifier	Used to pass an 'in' argument: The favourite contact's identifier
callback	called when the method call succeeds or fails; may be `NULL` to make a "fire and forget" call with no reply tracking
user_data	user-supplied data passed to the callback; must be `NULL` if `callback` is `NULL`
destroy	called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be `NULL` if `callback` is `NULL`
weak_object	If not `NULL`, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be `NULL` if `callback` is `NULL`

Returns

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_logger_callback_for_add_favourite_contact ()

void
(*tp_cli_logger_callback_for_add_favourite_contact)
                               (TpLogger *proxy,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a AddFavouriteContact method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_logger_callback_for_clear ()

void
(*tp_cli_logger_callback_for_clear) (TpLogger *proxy,
                                     const GError *error,
                                     gpointer user_data,
                                     GObject *weak_object);

Signature of the callback called when a Clear method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_logger_callback_for_clear_account ()

void
(*tp_cli_logger_callback_for_clear_account)
                               (TpLogger *proxy,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a ClearAccount method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_logger_callback_for_clear_entity ()

void
(*tp_cli_logger_callback_for_clear_entity)
                               (TpLogger *proxy,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a ClearEntity method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_logger_callback_for_get_favourite_contacts ()

void
(*tp_cli_logger_callback_for_get_favourite_contacts)
                               (TpLogger *proxy,
                                const GPtrArray *out_Favourite_Contacts,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a GetFavouriteContacts method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
out_Favourite_Contacts	Used to return an 'out' argument if `error` is `NULL`: The favourite contacts, as an array of TpAccounts and their contact identifiers.
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_logger_callback_for_remove_favourite_contact ()

void
(*tp_cli_logger_callback_for_remove_favourite_contact)
                               (TpLogger *proxy,
                                const GError *error,
                                gpointer user_data,
                                GObject *weak_object);

Signature of the callback called when a RemoveFavouriteContact method call succeeds or fails.

Parameters

proxy	the proxy on which the call was made
error	`NULL` on success, or an error on failure
user_data	user-supplied data
weak_object	user-supplied object

tp_cli_logger_connect_to_favourite_contacts_changed ()

TpProxySignalConnection *
tp_cli_logger_connect_to_favourite_contacts_changed
                               (TpLogger *proxy,
                                tp_cli_logger_signal_callback_favourite_contacts_changed callback,
                                gpointer user_data,
                                GDestroyNotify destroy,
                                GObject *weak_object,
                                GError **error);

Connect a handler to the signal FavouriteContactsChanged.

The set of favourite contacts has changed.

Parameters

proxy	A TpLogger or subclass
callback	Callback to be called when the signal is received
user_data	User-supplied data for the callback
destroy	Destructor for the user-supplied data, which will be called when this signal is disconnected, or before this function returns `NULL`
weak_object	A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected
error	If not `NULL`, used to raise an error if `NULL` is returned

Returns

a TpProxySignalConnection containing all of the above, which can be used to disconnect the signal; or NULL if the proxy does not have the desired interface or has become invalid.

tp_cli_logger_signal_callback_favourite_contacts_changed ()

void
(*tp_cli_logger_signal_callback_favourite_contacts_changed)
                               (TpLogger *proxy,
                                const gchar *arg_Account,
                                const gchar **arg_Added,
                                const gchar **arg_Removed,
                                gpointer user_data,
                                GObject *weak_object);

Represents the signature of a callback for the signal FavouriteContactsChanged.

Parameters

proxy	The proxy on which `tp_cli_logger_connect_to_favourite_contacts_changed()` was called
arg_Account	An account associated with the contact.
arg_Added	List of contact identifiers of contacts which are now favourites.
arg_Removed	List of contact identifiers of contacts which are no longer favourites.
user_data	User-supplied data
weak_object	User-supplied weakly referenced object

Types and Values

struct TpLogger

struct TpLogger;

Data structure representing a TpLogger.

Since 0.99.8

struct TpLoggerClass

struct TpLoggerClass {
};

The class of a TpLogger.

Since 0.99.8