|  |  |  | telepathy-glib API Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | ||||
| Connection ContactInfo interfaceConnection ContactInfo interface — client-side wrappers for the ContactInfo interface | 
#include <telepathy-glib/telepathy-glib-dbus.h> TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_get_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,tp_cli_connection_interface_contact_info_callback_for_get_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object); TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_refresh_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,tp_cli_connection_interface_contact_info_callback_for_refresh_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object); TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_request_contact_info (TpConnection *proxy,gint timeout_ms,guint in_Contact,tp_cli_connection_interface_contact_info_callback_for_request_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object); TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_set_contact_info (TpConnection *proxy,gint timeout_ms,const GPtrArray *in_ContactInfo,tp_cli_connection_interface_contact_info_callback_for_set_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object); void (*tp_cli_connection_interface_contact_info_callback_for_get_contact_info) (TpConnection *proxy,GHashTable *out_ContactInfo,const GError *error,gpointer user_data,GObject *weak_object); void (*tp_cli_connection_interface_contact_info_callback_for_refresh_contact_info) (TpConnection *proxy,const GError *error,gpointer user_data,GObject *weak_object); void (*tp_cli_connection_interface_contact_info_callback_for_request_contact_info) (TpConnection *proxy,const GPtrArray *out_Contact_Info,const GError *error,gpointer user_data,GObject *weak_object); void (*tp_cli_connection_interface_contact_info_callback_for_set_contact_info) (TpConnection *proxy,const GError *error,gpointer user_data,GObject *weak_object); TpProxySignalConnection * tp_cli_connection_interface_contact_info_connect_to_contact_info_changed (TpConnection *proxy,tp_cli_connection_interface_contact_info_signal_callback_contact_info_changed callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object,GError **error); gboolean tp_cli_connection_interface_contact_info_run_get_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,GHashTable **out_ContactInfo,GError **error,GMainLoop **loop); gboolean tp_cli_connection_interface_contact_info_run_refresh_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,GError **error,GMainLoop **loop); gboolean tp_cli_connection_interface_contact_info_run_request_contact_info (TpConnection *proxy,gint timeout_ms,guint in_Contact,GPtrArray **out_Contact_Info,GError **error,GMainLoop **loop); gboolean tp_cli_connection_interface_contact_info_run_set_contact_info (TpConnection *proxy,gint timeout_ms,const GPtrArray *in_ContactInfo,GError **error,GMainLoop **loop); void (*tp_cli_connection_interface_contact_info_signal_callback_contact_info_changed) (TpConnection *proxy,guint arg_Contact,const GPtrArray *arg_ContactInfo,gpointer user_data,GObject *weak_object);
An interface for requesting information about a contact on a given connection. The information is represented as a list of fields forming a structured representation of a vCard (as defined by RFC 2426), using field names and semantics defined therein.
This section documents the auto-generated C wrappers for the ContactInfo interface, used with TpConnection objects.
TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_get_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,tp_cli_connection_interface_contact_info_callback_for_get_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object);
Start a GetContactInfo method call.
Request information on several contacts at once. This SHOULD only return cached information, omitting handles for which no information is cached from the returned map.
| 
 | the TpProxy | 
| 
 | the timeout in milliseconds, or -1 to use the default | 
| 
 | Used to pass an 'in' argument: An array of handles representing contacts. | 
| 
 | called when the method call succeeds or fails;
may be NULLto make a "fire and forget" call with no
reply tracking | 
| 
 | user-supplied data passed to the callback;
must be NULLifcallbackisNULL | 
| 
 | called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULLifcallbackisNULL | 
| 
 | If not NULL, a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must beNULLifcallbackisNULL | 
| 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. | 
TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_refresh_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,tp_cli_connection_interface_contact_info_callback_for_refresh_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object);
Start a RefreshContactInfo method call.
Retrieve information for the given contact, requesting it from the network if an up-to-date version is not cached locally. This method SHOULD return immediately, emitting <tp:member-ref>ContactInfoChanged</tp:member-ref> when the contacts' updated contact information is returned. <tp:rationale> This method allows a client with cached contact information to update its cache after a number of days. </tp:rationale>
| 
 | the TpProxy | 
| 
 | the timeout in milliseconds, or -1 to use the default | 
| 
 | Used to pass an 'in' argument: Integer handles for contacts. | 
| 
 | called when the method call succeeds or fails;
may be NULLto make a "fire and forget" call with no
reply tracking | 
| 
 | user-supplied data passed to the callback;
must be NULLifcallbackisNULL | 
| 
 | called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULLifcallbackisNULL | 
| 
 | If not NULL, a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must beNULLifcallbackisNULL | 
| 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. | 
TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_request_contact_info (TpConnection *proxy,gint timeout_ms,guint in_Contact,tp_cli_connection_interface_contact_info_callback_for_request_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object);
Start a RequestContactInfo method call.
Retrieve information for a contact, requesting it from the network if it is not cached locally. <tp:rationale> This method is appropriate for an explicit user request to show a contact's information; it allows a UI to wait for the contact info to be returned. </tp:rationale>
| 
 | the TpProxy | 
| 
 | the timeout in milliseconds, or -1 to use the default | 
| 
 | Used to pass an 'in' argument: An integer handle for a contact. (TpContactHandle) | 
| 
 | called when the method call succeeds or fails;
may be NULLto make a "fire and forget" call with no
reply tracking | 
| 
 | user-supplied data passed to the callback;
must be NULLifcallbackisNULL | 
| 
 | called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULLifcallbackisNULL | 
| 
 | If not NULL, a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must beNULLifcallbackisNULL | 
| 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. | 
TpProxyPendingCall * tp_cli_connection_interface_contact_info_call_set_contact_info (TpConnection *proxy,gint timeout_ms,const GPtrArray *in_ContactInfo,tp_cli_connection_interface_contact_info_callback_for_set_contact_info callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object);
Start a SetContactInfo method call.
Set new contact information for this connection, replacing existing information. This method is only suppported if <tp:member-ref>ContactInfoFlags</tp:member-ref> contains <code>Can_Set</code>, and may only be passed fields conforming to <tp:member-ref>SupportedFields</tp:member-ref>.
| 
 | the TpProxy | 
| 
 | the timeout in milliseconds, or -1 to use the default | 
| 
 | Used to pass an 'in' argument: The new information to be set. | 
| 
 | called when the method call succeeds or fails;
may be NULLto make a "fire and forget" call with no
reply tracking | 
| 
 | user-supplied data passed to the callback;
must be NULLifcallbackisNULL | 
| 
 | called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be NULLifcallbackisNULL | 
| 
 | If not NULL, a GObject which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must beNULLifcallbackisNULL | 
| 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. | 
void (*tp_cli_connection_interface_contact_info_callback_for_get_contact_info) (TpConnection *proxy,GHashTable *out_ContactInfo,const GError *error,gpointer user_data,GObject *weak_object);
Signature of the callback called when a GetContactInfo method call succeeds or fails.
| 
 | the proxy on which the call was made | 
| 
 | Used to return an 'out' argument if errorisNULL: A dictionary mapping contact handles to information, whose keys are           the subset of the requested list of handles for which information was           cached. | 
| 
 | NULLon success, or an error on failure | 
| 
 | user-supplied data | 
| 
 | user-supplied object | 
void (*tp_cli_connection_interface_contact_info_callback_for_refresh_contact_info) (TpConnection *proxy,const GError *error,gpointer user_data,GObject *weak_object);
Signature of the callback called when a RefreshContactInfo method call succeeds or fails.
| 
 | the proxy on which the call was made | 
| 
 | NULLon success, or an error on failure | 
| 
 | user-supplied data | 
| 
 | user-supplied object | 
void (*tp_cli_connection_interface_contact_info_callback_for_request_contact_info) (TpConnection *proxy,const GPtrArray *out_Contact_Info,const GError *error,gpointer user_data,GObject *weak_object);
Signature of the callback called when a RequestContactInfo method call succeeds or fails.
void (*tp_cli_connection_interface_contact_info_callback_for_set_contact_info) (TpConnection *proxy,const GError *error,gpointer user_data,GObject *weak_object);
Signature of the callback called when a SetContactInfo method call succeeds or fails.
| 
 | the proxy on which the call was made | 
| 
 | NULLon success, or an error on failure | 
| 
 | user-supplied data | 
| 
 | user-supplied object | 
TpProxySignalConnection * tp_cli_connection_interface_contact_info_connect_to_contact_info_changed (TpConnection *proxy,tp_cli_connection_interface_contact_info_signal_callback_contact_info_changed callback,gpointer user_data,GDestroyNotify destroy,GObject *weak_object,GError **error);
Connect a handler to the signal ContactInfoChanged.
Emitted when a contact's information has changed or been received for the first time on this connection.
| 
 | A TpConnection or subclass | 
| 
 | Callback to be called when the signal is received | 
| 
 | User-supplied data for the callback | 
| 
 | Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns NULL | 
| 
 | A GObject which will be weakly referenced; if it is destroyed, this callback will automatically be disconnected | 
| 
 | If not NULL, used to raise an error ifNULLis
returned | 
| Returns : | a TpProxySignalConnection containing all of the
above, which can be used to disconnect the signal; or NULLif the proxy does not have the desired interface
or has become invalid. | 
gboolean tp_cli_connection_interface_contact_info_run_get_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,GHashTable **out_ContactInfo,GError **error,GMainLoop **loop);
tp_cli_connection_interface_contact_info_run_get_contact_info is deprecated and should not be used in newly-written code.
Call the method GetContactInfo and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
Request information on several contacts at once. This SHOULD only return cached information, omitting handles for which no information is cached from the returned map.
| 
 | A TpConnection or subclass | 
| 
 | Timeout in milliseconds, or -1 for default | 
| 
 | Used to pass an 'in' argument: An array of handles representing contacts. | 
| 
 | Used to return an 'out' argument if TRUEis returned: A dictionary mapping contact handles to information, whose keys are           the subset of the requested list of handles for which information was           cached. | 
| 
 | If not NULL, used to return errors ifFALSEis returned | 
| 
 | If not NULL, set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call withg_main_loop_quit(), causing a return ofFALSEwitherrorset toTP_DBUS_ERROR_CANCELLED | 
| Returns : | TRUE on success, FALSE and sets erroron error | 
gboolean tp_cli_connection_interface_contact_info_run_refresh_contact_info (TpConnection *proxy,gint timeout_ms,const GArray *in_Contacts,GError **error,GMainLoop **loop);
tp_cli_connection_interface_contact_info_run_refresh_contact_info is deprecated and should not be used in newly-written code.
Call the method RefreshContactInfo and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
Retrieve information for the given contact, requesting it from the network if an up-to-date version is not cached locally. This method SHOULD return immediately, emitting <tp:member-ref>ContactInfoChanged</tp:member-ref> when the contacts' updated contact information is returned. <tp:rationale> This method allows a client with cached contact information to update its cache after a number of days. </tp:rationale>
| 
 | A TpConnection or subclass | 
| 
 | Timeout in milliseconds, or -1 for default | 
| 
 | Used to pass an 'in' argument: Integer handles for contacts. | 
| 
 | If not NULL, used to return errors ifFALSEis returned | 
| 
 | If not NULL, set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call withg_main_loop_quit(), causing a return ofFALSEwitherrorset toTP_DBUS_ERROR_CANCELLED | 
| Returns : | TRUE on success, FALSE and sets erroron error | 
gboolean tp_cli_connection_interface_contact_info_run_request_contact_info (TpConnection *proxy,gint timeout_ms,guint in_Contact,GPtrArray **out_Contact_Info,GError **error,GMainLoop **loop);
tp_cli_connection_interface_contact_info_run_request_contact_info is deprecated and should not be used in newly-written code.
Call the method RequestContactInfo and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
Retrieve information for a contact, requesting it from the network if it is not cached locally. <tp:rationale> This method is appropriate for an explicit user request to show a contact's information; it allows a UI to wait for the contact info to be returned. </tp:rationale>
| 
 | A TpConnection or subclass | 
| 
 | Timeout in milliseconds, or -1 for default | 
| 
 | Used to pass an 'in' argument: An integer handle for a contact. (TpContactHandle) | 
| 
 | Used to return an 'out' argument if TRUEis returned: Information about that contact. | 
| 
 | If not NULL, used to return errors ifFALSEis returned | 
| 
 | If not NULL, set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call withg_main_loop_quit(), causing a return ofFALSEwitherrorset toTP_DBUS_ERROR_CANCELLED | 
| Returns : | TRUE on success, FALSE and sets erroron error | 
gboolean tp_cli_connection_interface_contact_info_run_set_contact_info (TpConnection *proxy,gint timeout_ms,const GPtrArray *in_ContactInfo,GError **error,GMainLoop **loop);
tp_cli_connection_interface_contact_info_run_set_contact_info is deprecated and should not be used in newly-written code.
Call the method SetContactInfo and run the main loop until it returns. Before calling this method, you must add a reference to any borrowed objects you need to keep, and generally ensure that everything is in a consistent state.
Set new contact information for this connection, replacing existing information. This method is only suppported if <tp:member-ref>ContactInfoFlags</tp:member-ref> contains <code>Can_Set</code>, and may only be passed fields conforming to <tp:member-ref>SupportedFields</tp:member-ref>.
| 
 | A TpConnection or subclass | 
| 
 | Timeout in milliseconds, or -1 for default | 
| 
 | Used to pass an 'in' argument: The new information to be set. | 
| 
 | If not NULL, used to return errors ifFALSEis returned | 
| 
 | If not NULL, set before re-entering
the main loop, to point to a GMainLoop
which can be used to cancel this call withg_main_loop_quit(), causing a return ofFALSEwitherrorset toTP_DBUS_ERROR_CANCELLED | 
| Returns : | TRUE on success, FALSE and sets erroron error | 
void (*tp_cli_connection_interface_contact_info_signal_callback_contact_info_changed) (TpConnection *proxy,guint arg_Contact,const GPtrArray *arg_ContactInfo,gpointer user_data,GObject *weak_object);
Represents the signature of a callback for the signal ContactInfoChanged.
| 
 | The proxy on which tp_cli_connection_interface_contact_info_connect_to_contact_info_changed()was called | 
| 
 | An integer handle for the contact whose info has changed. (TpContactHandle) | 
| 
 | <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> An array of fields representing information about this contact. | 
| 
 | User-supplied data | 
| 
 | User-supplied weakly referenced object |