TpConnectionNameListCb ()

void                (*TpConnectionNameListCb)           (const gchar * const *names,
                                                         gsize n,
                                                         const gchar * const *cms,
                                                         const gchar * const *protocols,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Signature of the callback supplied to tp_list_connection_names().

Since 0.7.1

tp_list_connection_names ()

void                tp_list_connection_names            (TpDBusDaemon *bus_daemon,
                                                         TpConnectionNameListCb callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

List the bus names of all the connections that currently exist, together with the connection manager name and the protocol name for each connection. Call the callback when done.

The bus names passed to the callback can be used to construct TpConnection objects for any connections that are of interest.

Since 0.7.1

TpConnection

typedef struct _TpConnection TpConnection;

A proxy object for a Telepathy connection. There are no interesting public struct fields.

(Changed in 0.7.12: the layout of the structure is visible, allowing subclassing.)

Since 0.7.1

struct TpConnectionClass

struct TpConnectionClass {
    TpProxyClass parent_class;
};

The class of a TpConnection. In addition to parent_class there are four pointers reserved for possible future use.

(Changed in 0.7.12: the layout of the structure is visible, allowing subclassing.)

Since 0.7.1

tp_connection_new ()

TpConnection *      tp_connection_new                   (TpDBusDaemon *dbus,
                                                         const gchar *bus_name,
                                                         const gchar *object_path,
                                                         GError **error);

Since 0.7.1

TP_CONNECTION_FEATURE_CORE

#define             TP_CONNECTION_FEATURE_CORE

Expands to a call to a function that returns a quark for the "core" feature on a TpConnection.

When this feature is prepared, the basic properties of the Connection have been retrieved and are available for use, and change-notification has been set up for those that can change.

Specifically, this implies that:

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.11.3

TP_CONNECTION_FEATURE_CONNECTED

#define             TP_CONNECTION_FEATURE_CONNECTED

Expands to a call to a function that returns a GQuark representing the "connected" feature.

When this feature is prepared, it means that the connection has become connected to the appropriate real-time communications service, and all information requested via other features has been updated accordingly. In particular, the following aspects of TP_CONNECTION_FEATURE_CORE will be up to date:

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.11.3

TP_CONNECTION_FEATURE_CAPABILITIES

#define             TP_CONNECTION_FEATURE_CAPABILITIES

Expands to a call to a function that returns a GQuark representing the "capabilities" feature.

When this feature is prepared, the Requests.RequestableChannelClasses property of the Connection has been retrieved. In particular, the TpConnection:capabilities property has been set.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.11.3

TP_CONNECTION_FEATURE_AVATAR_REQUIREMENTS

#define             TP_CONNECTION_FEATURE_AVATAR_REQUIREMENTS

Expands to a call to a function that returns a GQuark representing the "avatar-requirements" feature.

When this feature is prepared, the avatar requirements of the Connection has been retrieved. Use tp_connection_get_avatar_requirements() to get them once prepared.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.11.4

TP_CONNECTION_FEATURE_CONTACT_INFO

#define             TP_CONNECTION_FEATURE_CONTACT_INFO

Expands to a call to a function that returns a GQuark representing the "contact-info" feature.

When this feature is prepared, the ContactInfoFlags and SupportedFields of the Connection has been retrieved. Use tp_connection_get_contact_info_flags() and tp_connection_dup_contact_info_supported_fields() to get them once prepared.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.11.7

TP_CONNECTION_FEATURE_BALANCE

#define             TP_CONNECTION_FEATURE_BALANCE

Expands to a call to a function that returns a GQuark representing the "balance" feature.

When this feature is prepared, the Balance.AccountBalance and Balance.ManageCreditURI properties of the Connection have been retrieved. In particular, the TpConnection:balance, TpConnection:balance-scale, TpConnection:balance-currency and TpConnection:balance-uri properties have been set and the TpConnection::balance-changed: will be emitted when they are changed.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.15.1

TP_CONNECTION_FEATURE_CONTACT_LIST

#define             TP_CONNECTION_FEATURE_CONTACT_LIST

Expands to a call to a function that returns a GQuark representing the "contact-list" feature.

When this feature is prepared, the TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES has been prepared, so the contact list properties of the Connection has been retrieved. If "contact-list-state" is TP_CONTACT_LIST_STATE_SUCCESS, all TpContact objects will also be created and prepared with the desired features. See tp_connection_dup_contact_list() to get the list of contacts, and tp_simple_client_factory_add_contact_features() to define which features needs to be prepared on them.

This feature will fail to prepare when using obsolete Telepathy connection managers which do not implement the ContactList interface.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.15.5

TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES

#define             TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES

Expands to a call to a function that returns a GQuark representing the "contact-list-properties" feature.

When this feature is prepared, the contact list properties of the Connection has been retrieved. This feature will fail to prepare when using obsolete Telepathy connection managers which do not implement the ContactList interface.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.17.0

TP_CONNECTION_FEATURE_CONTACT_GROUPS

#define             TP_CONNECTION_FEATURE_CONTACT_GROUPS

Expands to a call to a function that returns a GQuark representing the "contact-groups" feature.

When this feature is prepared, the contact groups properties of the Connection has been retrieved.

See "contact-groups" to get the list of groups a contact is member of.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.15.5

TP_CONNECTION_FEATURE_CONTACT_BLOCKING

#define             TP_CONNECTION_FEATURE_CONTACT_BLOCKING

Expands to a call to a function that returns a GQuark representing the "contact-blocking" feature.

When this feature is prepared, "blocked-contacts" will contain an up-to-date list of TpContacts the user has blocked, and "can-report-abusive" will indicate whether abusive contacts can be reported to the server administrator.

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.17.0

TP_CONNECTION_FEATURE_ALIASING

#define             TP_CONNECTION_FEATURE_ALIASING

Expands to a call to a function that returns a GQuark representing the "aliasing" feature.

This feature needs to be prepared in order to use tp_connection_can_set_contact_alias().

One can ask for a feature to be prepared using the tp_proxy_prepare_async() function, and waiting for it to callback.

Since 0.17.3

tp_connection_run_until_ready ()

gboolean            tp_connection_run_until_ready       (TpConnection *self,
                                                         gboolean connect,
                                                         GError **error,
                                                         GMainLoop **loop);

If self is connected and ready for use, return immediately. Otherwise, call Connect() (unless connect is FALSE) and re-enter the main loop until the connection becomes invalid, the connection connects successfully and is introspected, or the main loop stored via loop is cancelled.

Since 0.7.1

TpConnectionWhenReadyCb ()

void                (*TpConnectionWhenReadyCb)          (TpConnection *connection,
                                                         const GError *error,
                                                         gpointer user_data);

Signature of a callback passed to tp_connection_call_when_ready(), which will be called exactly once, when the connection becomes ready or invalid (whichever happens first)

tp_connection_call_when_ready ()

void                tp_connection_call_when_ready       (TpConnection *self,
                                                         TpConnectionWhenReadyCb callback,
                                                         gpointer user_data);

If self is ready for use or has been invalidated, call callback immediately, then return. Otherwise, arrange for callback to be called when self either becomes ready for use or becomes invalid.

Note that if the connection is not in state CONNECTED, the callback will not be called until the connection either goes to state CONNECTED or is invalidated (e.g. by going to state DISCONNECTED or by becoming unreferenced). In particular, this method does not call Connect(). Call tp_cli_connection_call_connect() too, if you want to do that.

Since 0.7.7

tp_connection_is_ready ()

gboolean            tp_connection_is_ready              (TpConnection *self);

Returns the same thing as the "connection-ready" property.

Since 0.7.17

tp_connection_disconnect_async ()

void                tp_connection_disconnect_async      (TpConnection *self,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Disconnect the connection.

This method is intended for use by AccountManager implementations, such as Mission Control. To disconnect a connection managed by an AccountManager, either use tp_account_request_presence_async() or tp_account_set_enabled_async(), depending whether the intention is to put the account offline temporarily, or disable it longer-term.

Since 0.17.5

tp_connection_disconnect_finish ()

gboolean            tp_connection_disconnect_finish     (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Interpret the result of tp_connection_disconnect_async().

Since 0.17.5

tp_connection_get_account ()

TpAccount *         tp_connection_get_account           (TpConnection *self);

Return the the TpAccount associated with this connection. Will return NULL if self was not acquired from a TpAccount via tp_account_get_connection(), or if the account object got finalized in the meantime (TpConnection does not keep a strong ref on its TpAccount).

Since 0.15.5

tp_connection_get_status ()

TpConnectionStatus  tp_connection_get_status            (TpConnection *self,
                                                         TpConnectionStatusReason *reason);

If reason is not NULL it is set to the reason why "status" changed to its current value, or TP_CONNECTION_STATUS_REASON_NONE_SPECIFIED if unknown.

Since 0.7.14

tp_connection_get_connection_manager_name ()

const gchar *       tp_connection_get_connection_manager_name
                                                        (TpConnection *self);

Since 0.13.16

tp_connection_get_cm_name ()

const gchar *       tp_connection_get_cm_name           (TpConnection *self);

Since 0.19.3

tp_connection_get_protocol_name ()

const gchar *       tp_connection_get_protocol_name     (TpConnection *self);

Since 0.13.16

tp_connection_get_self_contact ()

TpContact *         tp_connection_get_self_contact      (TpConnection *self);

Return a TpContact representing the local user on this connection.

The returned object is not necessarily valid after the main loop is re-entered; ref it with g_object_ref() if you want to keep it.

Since 0.13.9

tp_connection_get_self_handle ()

TpHandle            tp_connection_get_self_handle       (TpConnection *self);

Return the TP_HANDLE_TYPE_CONTACT handle of the local user on this connection, or 0 if the self-handle is not known yet or the connection has become invalid (the TpProxy::invalidated signal).

The returned handle is not necessarily valid forever (the notify::self-handle signal will be emitted if it changes, which can happen on protocols such as IRC). Construct a TpContact object if you want to track the local user's identifier in the protocol, or other information like their presence status, over time.

Since 0.7.26

tp_connection_has_immortal_handles ()

gboolean            tp_connection_has_immortal_handles  (TpConnection *self);

Return TRUE if this connection is known to not destroy handles (TpHandle) until it disconnects.

On such connections, if you know that a handle maps to a particular identifier now, then you can rely on that handle mapping to that identifier for the whole lifetime of the connection.

TpConnectionRequestHandlesCb ()

void                (*TpConnectionRequestHandlesCb)     (TpConnection *connection,
                                                         TpHandleType handle_type,
                                                         guint n_handles,
                                                         const TpHandle *handles,
                                                         const gchar * const *ids,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Signature of the callback called when tp_connection_request_handles() succeeds or fails.

On success, the caller has a reference to each handle in handles.

Since telepathy-glib version 0.13.8, the handles will remain valid until connection becomes invalid (signalled by "invalidated"). In earlier versions, they could be released with tp_connection_unref_handles().

For convenience, the handle type and IDs requested by the caller are passed through to this callback, so the caller does not have to include them in user_data.

tp_connection_request_handles ()

void                tp_connection_request_handles       (TpConnection *self,
                                                         gint timeout_ms,
                                                         TpHandleType handle_type,
                                                         const gchar * const *ids,
                                                         TpConnectionRequestHandlesCb callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Request the handles corresponding to the given identifiers, and if they are valid, hold (ensure a reference to) the corresponding handles.

If they are valid, the callback will later be called with the given handles; if not all of them are valid, the callback will be called with an error.

TpConnectionHoldHandlesCb ()

void                (*TpConnectionHoldHandlesCb)        (TpConnection *connection,
                                                         TpHandleType handle_type,
                                                         guint n_handles,
                                                         const TpHandle *handles,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Signature of the callback called when tp_connection_hold_handles() succeeds or fails.

On success, the caller has a reference to each handle in handles.

Since telepathy-glib version 0.13.8, the handles will remain valid until connection becomes invalid (signalled by "invalidated"). In earlier versions, they could be released with tp_connection_unref_handles().

For convenience, the handle type and handles requested by the caller are passed through to this callback on success, so the caller does not have to include them in user_data.

tp_connection_get_contact_attributes ()

void                tp_connection_get_contact_attributes
                                                        (TpConnection *self,
                                                         gint timeout_ms,
                                                         guint n_handles,
                                                         const TpHandle *handles,
                                                         const gchar * const *interfaces,
                                                         gboolean hold,
                                                         tp_cli_connection_interface_contacts_callback_for_get_contact_attributes callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Return (via a callback) any number of attributes of the given handles.

Since telepathy-glib version 0.13.8, the handles will remain valid until connection becomes invalid (signalled by "invalidated"). In earlier versions, if hold was TRUE, the callback would hold a reference to them which could be released with tp_connection_unref_handles().

This is a thin wrapper around the GetContactAttributes D-Bus method, and should be used in preference to tp_cli_connection_interface_contacts_call_get_contact_attributes(); mixing this function, tp_connection_hold_handles(), tp_connection_unref_handles(), and TpContact with direct use of the RequestHandles, HoldHandles and GetContactAttributes D-Bus methods is unwise, as TpConnection and TpContact perform client-side reference counting of handles. The TpContact API provides a higher-level abstraction which should usually be used instead.

callback will later be called with the attributes of those of the given handles that were valid. Invalid handles are simply omitted from the parameter to the callback.

If hold is TRUE, the callback is given one reference to each handle that appears as a key in the callback's attributes parameter.

tp_connection_get_contact_list_attributes ()

void                tp_connection_get_contact_list_attributes
                                                        (TpConnection *self,
                                                         gint timeout_ms,
                                                         const gchar * const *interfaces,
                                                         gboolean hold,
                                                         tp_cli_connection_interface_contacts_callback_for_get_contact_attributes callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Return (via a callback) the contacts on the contact list and any number of their attributes.

Since telepathy-glib version 0.13.8, the handles will remain valid until connection becomes invalid (signalled by "invalidated"). In earlier versions, if hold was TRUE, the callback would hold a reference to them which could be released with tp_connection_unref_handles().

This is a thin wrapper around the RequestContactList D-Bus method, and should be used in preference to lower-level functions; it is similar to tp_connection_get_contact_attributes().

The TpContact API provides a higher-level abstraction which should usually be used instead.

If hold is TRUE, the callback is given a reference to each handle that appears as a key in the callback's attributes parameter.

tp_connection_hold_handles ()

void                tp_connection_hold_handles          (TpConnection *self,
                                                         gint timeout_ms,
                                                         TpHandleType handle_type,
                                                         guint n_handles,
                                                         const TpHandle *handles,
                                                         TpConnectionHoldHandlesCb callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Hold (ensure a reference to) the given handles, if they are valid.

If they are valid, the callback will later be called with the given handles; if not all of them are valid, the callback will be called with an error.

This function, along with tp_connection_unref_handles(), tp_connection_get_contact_attributes() and TpContact, keeps a client-side reference count of handles; you should not use the RequestHandles, HoldHandles and GetContactAttributes D-Bus methods directly as well as these functions.

tp_connection_unref_handles ()

void                tp_connection_unref_handles         (TpConnection *self,
                                                         TpHandleType handle_type,
                                                         guint n_handles,
                                                         const TpHandle *handles);

Do nothing. In versions of telepathy-glib prior to 0.13.8, this released a reference to the handles in handles.

tp_connection_init_known_interfaces ()

void                tp_connection_init_known_interfaces (void);

Ensure that the known interfaces for TpConnection 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_CONNECTION.

Since 0.7.6

tp_connection_presence_type_cmp_availability ()

gint                tp_connection_presence_type_cmp_availability
                                                        (TpConnectionPresenceType p1,
                                                         TpConnectionPresenceType p2);

Compares p1 and p2 like strcmp(). p1 > p2 means p1 is more available than p2.

The order used is: available > busy > away > xa > hidden > offline > error > unknown > unset

Since 0.7.16

tp_connection_parse_object_path ()

gboolean            tp_connection_parse_object_path     (TpConnection *self,
                                                         gchar **protocol,
                                                         gchar **cm_name);

If the object path of connection is in the correct form, set protocol and cm_name, return TRUE. Otherwise leave them unchanged and return FALSE.

Since 0.7.27

tp_connection_get_capabilities ()

TpCapabilities *    tp_connection_get_capabilities      (TpConnection *self);

Since 0.11.3

tp_connection_get_avatar_requirements ()

TpAvatarRequirements * tp_connection_get_avatar_requirements
                                                        (TpConnection *self);

To wait for valid avatar requirements, call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_AVATAR_REQUIREMENTS.

This property cannot change after self goes to the Connected state.

Since 0.11.4

tp_connection_get_contact_info_flags ()

TpContactInfoFlags  tp_connection_get_contact_info_flags
                                                        (TpConnection *self);

Returns the flags describing how contact info (vCards) behaves on this connection

To wait for valid contact info flags, call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_INFO.

This property cannot change after self goes to the Connected state.

Since 0.11.7

tp_connection_get_contact_info_supported_fields ()

GList *             tp_connection_get_contact_info_supported_fields
                                                        (TpConnection *self);

Returns a newly allocated GList of supported contact info fields for this connection. The list must be freed with g_list_free() after used.

Note that the TpContactInfoFieldSpecs in the returned GList are not dupped before returning from this function. One could copy every item in the list using tp_contact_info_field_spec_copy().

To wait for valid supported fields, call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_INFO.

This property cannot change after self goes to the Connected state.

Since 0.11.7

tp_connection_dup_contact_info_supported_fields ()

GList *             tp_connection_dup_contact_info_supported_fields
                                                        (TpConnection *self);

Returns a newly allocated GList of supported contact info fields for this connection. The list must be freed with tp_contact_info_spec_list_free().

To wait for valid supported fields, call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_INFO.

This property cannot change after self goes to the Connected state.

Since 0.19.9

tp_connection_set_contact_info_async ()

void                tp_connection_set_contact_info_async
                                                        (TpConnection *self,
                                                         GList *info,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Requests an asynchronous set of the contact info of self. When the operation is finished, callback will be called. You can then call tp_connection_set_contact_info_finish() to get the result of the operation.

This method should not be expected to succeed if the result of tp_connection_get_contact_info_flags() does not include TP_CONTACT_INFO_FLAG_CAN_SET.

Since 0.11.7

tp_connection_set_contact_info_finish ()

gboolean            tp_connection_set_contact_info_finish
                                                        (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes an async set of self info.

Since 0.11.7

TP_UNKNOWN_CONNECTION_STATUS

#define TP_UNKNOWN_CONNECTION_STATUS ((TpConnectionStatus) -1)

An invalid connection status used in TpConnection to indicate that the status has not yet been discovered.

Since 0.7.1

TP_ERRORS_DISCONNECTED

#define TP_ERRORS_DISCONNECTED (tp_errors_disconnected_quark ())

GError domain representing a Telepathy connection becoming disconnected. The code in a GError with this domain must be a member of TpConnectionStatusReason.

This macro expands to a function call returning a GQuark.

Since 0.7.24, this error domain is only used if a connection manager emits a TpConnectionStatusReason not known to telepathy-glib.

Since 0.7.1

tp_connection_get_detailed_error ()

const gchar *       tp_connection_get_detailed_error    (TpConnection *self,
                                                         const GHashTable **details);

If the connection has disconnected, return the D-Bus error name with which it disconnected (in particular, this is TP_ERROR_STR_CANCELLED if it was disconnected by a user request).

Otherwise, return NULL, without altering details.

Since 0.11.4

tp_connection_dup_detailed_error_vardict ()

gchar *             tp_connection_dup_detailed_error_vardict
                                                        (TpConnection *self,
                                                         GVariant **details);

If the connection has disconnected, return the D-Bus error name with which it disconnected (in particular, this is TP_ERROR_STR_CANCELLED if it was disconnected by a user request).

Otherwise, return NULL, without altering details.

Since 0.19.0

tp_connection_add_client_interest ()

void                tp_connection_add_client_interest   (TpConnection *self,
                                                         const gchar *interested_in);

Subscribe to any opt-in change notifications for interested_in.

For contact information, use TpContact instead, which will call this automatically.

Since 0.11.3

tp_connection_add_client_interest_by_id ()

void                tp_connection_add_client_interest_by_id
                                                        (TpConnection *self,
                                                         GQuark interested_in);

Subscribe to any opt-in change notifications for interested_in.

Equivalent to, but a little more efficient than, calling tp_connection_add_client_interest() for the string value of interested_in.

Since 0.11.3

tp_connection_bind_connection_status_to_property ()

GBinding *          tp_connection_bind_connection_status_to_property
                                                        (TpConnection *self,
                                                         gpointer target,
                                                         const char *target_property,
                                                         gboolean invert);

Binds the :status of self to the boolean property of another object using a GBinding such that the target_property will be set to TRUE when self is connected (and invert is FALSE).

target_property will be synchronised immediately (G_BINDING_SYNC_CREATE). invert can be interpreted as analogous to G_BINDING_INVERT_BOOLEAN.

For instance, this function can be used to bind the GtkWidget:sensitive property to only make a widget sensitive when the account is connected.

See g_object_bind_property() for more information.

Since 0.13.16

tp_connection_get_balance ()

gboolean            tp_connection_get_balance           (TpConnection *self,
                                                         gint *balance,
                                                         guint *scale,
                                                         const gchar **currency);

If self has a valid account balance, returns TRUE and sets the variables pointed to by balance, scale and currency to the appropriate fields of the Balance.AccountBalance property.

The monetary value of the balance is expressed as a fixed-point number, balance, with a decimal scale defined by scale; for instance a balance of 1234 with scale of 2 represents a value of "12.34" in the currency represented by currency.

Requires TP_CONNECTION_FEATURE_BALANCE to be prepared.

Since 0.15.1

tp_connection_get_balance_uri ()

const gchar *       tp_connection_get_balance_uri       (TpConnection *self);

The value of Balance.ManageCreditURI.

Requires TP_CONNECTION_FEATURE_BALANCE to be prepared.

Since 0.15.1

TP_TYPE_AVATAR_REQUIREMENTS

#define TP_TYPE_AVATAR_REQUIREMENTS (tp_avatar_requirements_get_type ())

The boxed type of a TpAvatarRequirements.

Since 0.11.4

struct TpAvatarRequirements

struct TpAvatarRequirements {
  GStrv supported_mime_types;
  guint minimum_width;
  guint minimum_height;
  guint recommended_width;
  guint recommended_height;
  guint maximum_width;
  guint maximum_height;
  guint maximum_bytes;
};

The requirements for setting an avatar on a particular protocol.

Since 0.11.4

tp_avatar_requirements_new ()

TpAvatarRequirements * tp_avatar_requirements_new       (GStrv supported_mime_types,
                                                         guint minimum_width,
                                                         guint minimum_height,
                                                         guint recommended_width,
                                                         guint recommended_height,
                                                         guint maximum_width,
                                                         guint maximum_height,
                                                         guint maximum_bytes);

Since 0.11.4

tp_avatar_requirements_copy ()

TpAvatarRequirements * tp_avatar_requirements_copy      (const TpAvatarRequirements *self);

Since 0.11.4

tp_avatar_requirements_destroy ()

void                tp_avatar_requirements_destroy      (TpAvatarRequirements *self);

Free all memory used by the TpAvatarRequirements.

Since 0.11.4

struct TpContactInfoFieldSpec

struct TpContactInfoFieldSpec {
  gchar *name;
  GStrv parameters;
  TpContactInfoFieldFlags flags;
  guint max;
};

A struct describing a vCard field.

Since 0.11.7

TP_TYPE_CONTACT_INFO_FIELD_SPEC

#define TP_TYPE_CONTACT_INFO_FIELD_SPEC (tp_contact_info_field_spec_get_type ())

The boxed type of a TpContactInfoFieldSpec.

Since 0.11.7

tp_contact_info_field_spec_copy ()

TpContactInfoFieldSpec * tp_contact_info_field_spec_copy
                                                        (const TpContactInfoFieldSpec *self);

Since 0.11.7

tp_contact_info_field_spec_free ()

void                tp_contact_info_field_spec_free     (TpContactInfoFieldSpec *self);

Free all memory used by the TpContactInfoFieldSpec.

Since 0.11.7

TP_TYPE_CONTACT_INFO_SPEC_LIST

#define TP_TYPE_CONTACT_INFO_SPEC_LIST (tp_contact_info_spec_list_get_type ())

The boxed type of a GList of TpContactInfoFieldSpec.

Since 0.11.7

tp_contact_info_spec_list_copy ()

GList *             tp_contact_info_spec_list_copy      (GList *list);

Since 0.11.7

tp_contact_info_spec_list_free ()

void                tp_contact_info_spec_list_free      (GList *list);

Free all memory used by the GList and its elements.

Since 0.11.7

struct TpContactInfoField

struct TpContactInfoField {
  gchar *field_name;
  GStrv parameters;
  GStrv field_value;
};

A structure representing an information about a contact. Similar to a vCard field.

Since 0.11.7

TP_TYPE_CONTACT_INFO_FIELD

#define TP_TYPE_CONTACT_INFO_FIELD (tp_contact_info_field_get_type ())

The boxed type of a TpContactInfoField.

Since 0.11.7

tp_contact_info_field_new ()

TpContactInfoField * tp_contact_info_field_new          (const gchar *field_name,
                                                         GStrv parameters,
                                                         GStrv field_value);

Since 0.11.7

tp_contact_info_field_copy ()

TpContactInfoField * tp_contact_info_field_copy         (const TpContactInfoField *self);

Since 0.11.7

tp_contact_info_field_free ()

void                tp_contact_info_field_free          (TpContactInfoField *self);

Free all memory used by the TpContactInfoField.

Since 0.11.7

TP_TYPE_CONTACT_INFO_LIST

#define TP_TYPE_CONTACT_INFO_LIST (tp_contact_info_list_get_type ())

The boxed type of a GList of TpContactInfoField.

Since 0.11.7

tp_contact_info_list_copy ()

GList *             tp_contact_info_list_copy           (GList *list);

Since 0.11.7

tp_contact_info_list_free ()

void                tp_contact_info_list_free           (GList *list);

Free all memory used by the GList and its elements.

Since 0.11.7

tp_connection_get_contact_list_state ()

TpContactListState  tp_connection_get_contact_list_state
                                                        (TpConnection *self);

Since 0.15.5

tp_connection_get_contact_list_persists ()

gboolean            tp_connection_get_contact_list_persists
                                                        (TpConnection *self);

Since 0.15.5

tp_connection_get_can_change_contact_list ()

gboolean            tp_connection_get_can_change_contact_list
                                                        (TpConnection *self);

Since 0.15.5

tp_connection_get_request_uses_message ()

gboolean            tp_connection_get_request_uses_message
                                                        (TpConnection *self);

Since 0.15.5

tp_connection_dup_contact_list ()

GPtrArray *         tp_connection_dup_contact_list      (TpConnection *self);

Retrieves the user's contact list. In general, blocked contacts are not included in this list. The TpContact objects returned are guaranteed to have all of the features previously passed to tp_simple_client_factory_add_contact_features() prepared.

Before calling this method, you must first call tp_proxy_prepare_async() with the TP_CONNECTION_FEATURE_CONTACT_LIST feature, and verify that "contact-list-state" is set to TP_CONTACT_LIST_STATE_SUCCESS.

Since 0.15.5

tp_connection_request_subscription_async ()

void                tp_connection_request_subscription_async
                                                        (TpConnection *self,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         const gchar *message,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Request that the given contacts allow the local user to subscribe to their presence, i.e. that their "subscribe-state" property becomes TP_SUBSCRIPTION_STATE_YES.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_LIST.

Since 0.15.5

tp_connection_request_subscription_finish ()

gboolean            tp_connection_request_subscription_finish
                                                        (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_request_subscription_async()

Since 0.15.5

tp_connection_authorize_publication_async ()

void                tp_connection_authorize_publication_async
                                                        (TpConnection *self,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

For each of the given contacts, request that the local user's presence is sent to that contact, i.e. that their "publish-state" property becomes TP_SUBSCRIPTION_STATE_YES.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_LIST.

Since 0.15.5

tp_connection_authorize_publication_finish ()

gboolean            tp_connection_authorize_publication_finish
                                                        (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_authorize_publication_async()

Since 0.15.5

tp_connection_remove_contacts_async ()

void                tp_connection_remove_contacts_async (TpConnection *self,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Remove the given contacts from the contact list entirely. It is protocol-dependent whether this works, and under which circumstances.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_LIST.

Since 0.15.5

tp_connection_remove_contacts_finish ()

gboolean            tp_connection_remove_contacts_finish
                                                        (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_remove_contacts_async()

Since 0.15.5

tp_connection_unsubscribe_async ()

void                tp_connection_unsubscribe_async     (TpConnection *self,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Attempt to set the given contacts' "subscribe-state" property to TP_SUBSCRIPTION_STATE_NO, i.e. stop receiving their presence.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_LIST.

Since 0.15.5

tp_connection_unsubscribe_finish ()

gboolean            tp_connection_unsubscribe_finish    (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_unsubscribe_async()

Since 0.15.5

tp_connection_unpublish_async ()

void                tp_connection_unpublish_async       (TpConnection *self,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Attempt to set the given contacts' "publish-state" property to TP_SUBSCRIPTION_STATE_NO, i.e. stop sending presence to them.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_LIST.

Since 0.15.5

tp_connection_unpublish_finish ()

gboolean            tp_connection_unpublish_finish      (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_unpublish_async()

Since 0.15.5

tp_connection_get_disjoint_groups ()

gboolean            tp_connection_get_disjoint_groups   (TpConnection *self);

Since 0.15.5

tp_connection_get_group_storage ()

TpContactMetadataStorageType tp_connection_get_group_storage
                                                        (TpConnection *self);

Since 0.15.5

tp_connection_get_contact_groups ()

const gchar * const * tp_connection_get_contact_groups  (TpConnection *self);

Since 0.15.5

tp_connection_set_group_members_async ()

void                tp_connection_set_group_members_async
                                                        (TpConnection *self,
                                                         const gchar *group,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Add the given contacts to the given group (creating it if necessary), and remove all other members.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_GROUPS.

Since 0.15.5

tp_connection_set_group_members_finish ()

gboolean            tp_connection_set_group_members_finish
                                                        (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_set_group_members_async()

Since 0.15.5

tp_connection_add_to_group_async ()

void                tp_connection_add_to_group_async    (TpConnection *self,
                                                         const gchar *group,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Add the given contacts to the given group, creating it if necessary.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_GROUPS.

Since 0.15.5

tp_connection_add_to_group_finish ()

gboolean            tp_connection_add_to_group_finish   (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_add_to_group_async()

Since 0.15.5

tp_connection_remove_from_group_async ()

void                tp_connection_remove_from_group_async
                                                        (TpConnection *self,
                                                         const gchar *group,
                                                         guint n_contacts,
                                                         TpContact * const *contacts,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Remove the given contacts from the given group. If there are no members left in the group afterwards, the group MAY itself be removed.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_GROUPS.

Since 0.15.5

tp_connection_remove_from_group_finish ()

gboolean            tp_connection_remove_from_group_finish
                                                        (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_remove_from_group_async()

Since 0.15.5

tp_connection_remove_group_async ()

void                tp_connection_remove_group_async    (TpConnection *self,
                                                         const gchar *group,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Remove all members from the given group, then remove the group itself.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_GROUPS.

Since 0.15.5

tp_connection_remove_group_finish ()

gboolean            tp_connection_remove_group_finish   (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_remove_group_async()

Since 0.15.5

tp_connection_rename_group_async ()

void                tp_connection_rename_group_async    (TpConnection *self,
                                                         const gchar *old_name,
                                                         const gchar *new_name,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Rename the given old_name.

On protocols where groups behave like tags, this is an API short-cut for adding all of the group's members to a group with the new name, then removing the old group.

For this to work properly self must have interface TP_IFACE_CONNECTION_INTERFACE_CONTACT_GROUPS.

Since 0.15.5

tp_connection_rename_group_finish ()

gboolean            tp_connection_rename_group_finish   (TpConnection *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_connection_rename_group_async()