Connection Aliasing interface

Connection Aliasing interface — client-side wrappers for the Aliasing interface

Synopsis

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

TpProxyPendingCall * tp_cli_connection_interface_aliasing1_call_request_aliases
                                                        (TpConnection *proxy,
                                                         gint timeout_ms,
                                                         const GArray *in_Contacts,
                                                         tp_cli_connection_interface_aliasing1_callback_for_request_aliases callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);
TpProxyPendingCall * tp_cli_connection_interface_aliasing1_call_set_aliases
                                                        (TpConnection *proxy,
                                                         gint timeout_ms,
                                                         GHashTable *in_Aliases,
                                                         tp_cli_connection_interface_aliasing1_callback_for_set_aliases callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);
void                (*tp_cli_connection_interface_aliasing1_callback_for_request_aliases)
                                                        (TpConnection *proxy,
                                                         const gchar **out_Aliases,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);
void                (*tp_cli_connection_interface_aliasing1_callback_for_set_aliases)
                                                        (TpConnection *proxy,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);
TpProxySignalConnection * tp_cli_connection_interface_aliasing1_connect_to_aliases_changed
                                                        (TpConnection *proxy,
                                                         tp_cli_connection_interface_aliasing1_signal_callback_aliases_changed callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object,
                                                         GError **error);
void                (*tp_cli_connection_interface_aliasing1_signal_callback_aliases_changed)
                                                        (TpConnection *proxy,
                                                         GHashTable *arg_Aliases,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Description

Most instant messaging protocols allow users to set a nickname or alias. This section documents the auto-generated C wrappers for the Aliasing interface, used with TpConnection objects.

Details

tp_cli_connection_interface_aliasing1_call_request_aliases ()

TpProxyPendingCall * tp_cli_connection_interface_aliasing1_call_request_aliases
                                                        (TpConnection *proxy,
                                                         gint timeout_ms,
                                                         const GArray *in_Contacts,
                                                         tp_cli_connection_interface_aliasing1_callback_for_request_aliases callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a RequestAliases method call.

Request the value of several contacts' aliases at once.

proxy :

the TpProxy

timeout_ms :

the timeout in milliseconds, or -1 to use the default

in_Contacts :

Used to pass an 'in' argument: An array of handles representing contacts

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_connection_interface_aliasing1_call_set_aliases ()

TpProxyPendingCall * tp_cli_connection_interface_aliasing1_call_set_aliases
                                                        (TpConnection *proxy,
                                                         gint timeout_ms,
                                                         GHashTable *in_Aliases,
                                                         tp_cli_connection_interface_aliasing1_callback_for_set_aliases callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a SetAliases method call.

Request that the alias of the given contact be changed. Success will be indicated by emitting an <tp:member-ref>AliasesChanged</tp:member-ref> signal. On connections where the CONNECTION_ALIAS_FLAG_USER_SET flag is not set, this method will only ever succeed if the contact is the user's own handle (as returned by the <tp:dbus-ref namespace="im.telepathy.v1">Connection.SelfHandle</tp:dbus-ref> property).

proxy :

the TpProxy

timeout_ms :

the timeout in milliseconds, or -1 to use the default

in_Aliases :

Used to pass an 'in' argument: A dictionary mapping integer handles of contacts to strings of the new alias to set.

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_connection_interface_aliasing1_callback_for_request_aliases ()

void                (*tp_cli_connection_interface_aliasing1_callback_for_request_aliases)
                                                        (TpConnection *proxy,
                                                         const gchar **out_Aliases,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

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

proxy :

the proxy on which the call was made

out_Aliases :

Used to return an 'out' argument if error is NULL: A list of aliases in the same order as the contact handles

error :

NULL on success, or an error on failure

user_data :

user-supplied data

weak_object :

user-supplied object

tp_cli_connection_interface_aliasing1_callback_for_set_aliases ()

void                (*tp_cli_connection_interface_aliasing1_callback_for_set_aliases)
                                                        (TpConnection *proxy,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

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

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_connection_interface_aliasing1_connect_to_aliases_changed ()

TpProxySignalConnection * tp_cli_connection_interface_aliasing1_connect_to_aliases_changed
                                                        (TpConnection *proxy,
                                                         tp_cli_connection_interface_aliasing1_signal_callback_aliases_changed callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object,
                                                         GError **error);

Connect a handler to the signal AliasesChanged.

Signal emitted when a contact's alias (or that of the user) is changed.

proxy :

A TpConnection 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_connection_interface_aliasing1_signal_callback_aliases_changed ()

void                (*tp_cli_connection_interface_aliasing1_signal_callback_aliases_changed)
                                                        (TpConnection *proxy,
                                                         GHashTable *arg_Aliases,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Represents the signature of a callback for the signal AliasesChanged.

proxy :

The proxy on which tp_cli_connection_interface_aliasing1_connect_to_aliases_changed() was called

arg_Aliases :

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> A mapping from the handle representing the contact to the new alias

user_data :

User-supplied data

weak_object :

User-supplied weakly referenced object

See Also

TpConnection