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_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_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_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_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_dup_detailed_error ()

gchar *
tp_connection_dup_detailed_error (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

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

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

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_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_LIST1.

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_LIST1.

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_LIST1.

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_LIST1.

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_LIST1.

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_GROUPS1.

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_GROUPS1.

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_GROUPS1.

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_GROUPS1.

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_GROUPS1.

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

Since 0.15.5

tp_connection_block_contacts_async ()

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

Direct the server to block contacts .

Since 0.17.0

tp_connection_block_contacts_finish ()

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

Finishes tp_connection_block_contacts_async()

Since 0.17.0

tp_connection_unblock_contacts_async ()

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

Direct the server to unblock contacts .

Since 0.17.0

tp_connection_unblock_contacts_finish ()

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

Finishes tp_connection_unblock_contacts_async()

Since 0.17.0

tp_connection_can_report_abusive ()

gboolean
tp_connection_can_report_abusive (TpConnection *self);

Since 0.17.0

tp_connection_get_blocked_contacts ()

GPtrArray *
tp_connection_get_blocked_contacts (TpConnection *self);

Since 0.17.0

tp_connection_can_set_contact_alias ()

gboolean
tp_connection_can_set_contact_alias (TpConnection *self);

Check if the user can set aliases on his contacts. TP_CONNECTION_FEATURE_ALIASING needs to be prepared for this function to return a meaningful value.

Since 0.17.3

struct TpConnection

struct 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_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_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

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

struct TpContactInfoFieldSpec

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

A struct describing a vCard field.

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

The “balance” property

  “balance”                  gint

The Amount field of the Balance.AccountBalance property.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_BALANCE.

See Also: tp_connection_get_balance()

Flags: Read

Default value: 0

The “balance-currency” property

  “balance-currency”         gchar *

The Currency field of the Balance.AccountBalance property.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_BALANCE.

See Also: tp_connection_get_balance()

Flags: Read

Default value: NULL

The “balance-scale” property

  “balance-scale”            guint

The Scale field of the Balance.AccountBalance property.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_BALANCE.

See Also: tp_connection_get_balance()

Flags: Read

Default value: 4294967295

The “balance-uri” property

  “balance-uri”              gchar *

The Balance.ManageCreditURI property.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_BALANCE.

Flags: Read

Default value: NULL

The “blocked-contacts” property

  “blocked-contacts”         GPtrArray *

A GPtrArray of blocked TpContact. Changes are notified using the “blocked-contacts-changed” signal.

These TpContact objects have been prepared with the desired features. See tp_client_factory_add_contact_features() to define which features needs to be prepared on them.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_BLOCKING.

Flags: Read

Since 0.17.0

The “can-change-contact-list” property

  “can-change-contact-list”  gboolean

If true, presence subscription and publication can be changed using the RequestSubscription, AuthorizePublication and RemoveContacts methods.

Rational: link-local XMPP, presence is implicitly published to everyone in the local subnet, so the user cannot control their presence publication.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES or TP_CONNECTION_FEATURE_CONTACT_LIST.

Flags: Read

Default value: FALSE

Since 0.15.5

The “can-report-abusive” property

  “can-report-abusive”       gboolean

If this property is TRUE, contacts may be reported as abusive to the server administrators by setting report_abusive to TRUE when calling tp_connection_block_contacts_async().

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_BLOCKING.

Flags: Read

Default value: FALSE

Since 0.17.0

The “capabilities” property

  “capabilities”             TpCapabilities *

The TpCapabilities object representing the capabilities of this connection, or NULL if we don't know yet.

To wait for valid capability information, call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CAPABILITIES.

Flags: Read

The “cm-name” property

  “cm-name”                  gchar *

This connection's connection manager name.

Flags: Read

Default value: NULL

Since 0.19.3

The “contact-groups” property

  “contact-groups”           GStrv

The names of all groups that currently exist. This may be a larger set than the union of all “contact-groups” properties, if the connection allows groups to be empty.

This property's value is not meaningful until the “contact-list-state” property has become TP_CONTACT_LIST_STATE_SUCCESS.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_GROUPS.

Flags: Read

Since 0.15.5

The “contact-list-persists” property

  “contact-list-persists”    gboolean

If true, presence subscriptions (in both directions) on this connection are stored by the server or other infrastructure.

If false, presence subscriptions on this connection are not stored.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES or TP_CONNECTION_FEATURE_CONTACT_LIST.

Flags: Read

Default value: FALSE

Since 0.15.5

The “contact-list-state” property

  “contact-list-state”       guint

The progress made in retrieving the contact list.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES or TP_CONNECTION_FEATURE_CONTACT_LIST.

Flags: Read

Default value: 0

Since 0.15.5

The “disjoint-groups” property

  “disjoint-groups”          gboolean

True if each contact can be in at most one group; false if each contact can be in many groups.

This property cannot change after the connection has moved to the TP_CONNECTION_STATUS_CONNECTED state. Until then, its value is undefined, and it may change at any time, without notification.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_GROUPS.

Flags: Read

Default value: FALSE

Since 0.15.5

The “group-storage” property

  “group-storage”            guint

Indicates the extent to which contacts' groups can be set and stored.

This property cannot change after the connection has moved to the TP_CONNECTION_STATUS_CONNECTED state. Until then, its value is undefined, and it may change at any time, without notification.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_GROUPS.

Flags: Read

Default value: 0

Since 0.15.5

The “protocol-name” property

  “protocol-name”            gchar *

The connection's machine-readable protocol name, such as "jabber", "msn" or "local-xmpp". Recommended names for most protocols can be found in the Telepathy D-Bus Interface Specification.

Flags: Read

Default value: NULL

Since 0.13.16

The “request-uses-message” property

  “request-uses-message”     gboolean

If true, the Message parameter to RequestSubscription is likely to be significant, and user interfaces SHOULD prompt the user for a message to send with the request; a message such as "I would like to add you to my contact list", translated into the local user's language, might make a suitable default.

For this property to be valid, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_LIST_PROPERTIES or TP_CONNECTION_FEATURE_CONTACT_LIST.

Flags: Read

Default value: FALSE

Since 0.15.5

The “self-contact” property

  “self-contact”             TpContact *

A TpContact representing the local user on this connection, or NULL if not yet available.

If the local user's unique identifier changes (for instance by using /nick on IRC), this property will change to a different TpContact object representing the new identifier, and “notify” will be emitted.

The TpContact object is guaranteed to have all of the features previously passed to tp_client_factory_add_contact_features() prepared.

To wait for a non-NULL self-contact (and other properties), call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONNECTED.

Flags: Read

Since 0.13.9

The “status” property

  “status”                   guint

This connection's status, or TP_UNKNOWN_CONNECTION_STATUS if we don't know yet.

To wait for a valid status (and other properties), call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CORE.

Since version 0.11.3, the change to status TP_CONNECTION_STATUS_CONNECTED is delayed slightly, until introspection of the connection has finished.

Flags: Read

Default value: 4294967295

The “status-reason” property

  “status-reason”            guint

To wait for a valid status (and other properties), call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CORE.

The reason why “status” changed to its current value, or TP_CONNECTION_STATUS_REASON_NONE_SPECIFIED if unknown. know yet.

Flags: Read

Default value: 0

The “balance-changed” signal

void
user_function (TpConnection *self,
               gint          balance,
               guint         balance_scale,
               gchar        *balance_currency,
               gpointer      user_data)

Emitted when at least one of the “balance”, “balance-scale” or “balance-currency” property is changed.

For this signal to be emitted, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_BALANCE.

Flags: Has Details

Since 0.15.1

The “blocked-contacts-changed” signal

void
user_function (TpConnection *self,
               GPtrArray    *added,
               GPtrArray    *removed,
               gpointer      user_data)

Notify of changes in “blocked-contacts”. It is guaranteed that all contacts have desired features prepared. See tp_client_factory_add_contact_features() to define which features needs to be prepared.

This signal is also emitted for the initial set of blocked contacts once retrieved.

For this signal to be emitted, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_BLOCKING.

Flags: Run Last

Since 0.17.0

The “contact-list-changed” signal

void
user_function (TpConnection *self,
               GPtrArray    *added,
               GPtrArray    *removed,
               gpointer      user_data)

Notify of changes in the list of contacts as returned by tp_connection_dup_contact_list(). It is guaranteed that all contacts have desired features prepared. See tp_client_factory_add_contact_features() to define which features needs to be prepared.

This signal is also emitted for the initial set of contacts once retrieved.

For this signal to be emitted, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_LIST.

Flags: Run Last

Since 0.15.5

The “group-renamed” signal

void
user_function (TpConnection *self,
               gchar        *old_name,
               gchar        *new_name,
               gpointer      user_data)

Emitted when a group is renamed, in protocols where this can be distinguished from group creation, removal and membership changes.

Immediately after this signal is emitted, “groups-created” signal the creation of a group with the new name, and “groups-removed” signal the removal of a group with the old name. If the group was not empty, immediately after those signals are emitted, “contact-groups-changed” signal that the members of that group were removed from the old name and added to the new name.

When this signal is emitted, “contact-groups” property is already updated.

For this signal to be emited, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_GROUPS.

Flags: Run Last

Since 0.15.5

The “groups-created” signal

void
user_function (TpConnection *self,
               GStrv         added,
               gpointer      user_data)

Emitted when new, empty groups are created. This will often be followed by “contact-groups-changed” signals that add some members. When this signal is emitted, “contact-groups” property is already updated.

For this signal to be emited, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_GROUPS.

Flags: Run Last

Since 0.15.5

The “groups-removed” signal

void
user_function (TpConnection *self,
               GStrv         added,
               gpointer      user_data)

Emitted when one or more groups are removed. If they had members at the time that they were removed, then immediately after this signal is emitted, “contact-groups-changed” signals that their members were removed. When this signal is emitted, “contact-groups” property is already updated.

For this signal to be emited, you must first call tp_proxy_prepare_async() with the feature TP_CONNECTION_FEATURE_CONTACT_GROUPS.

Flags: Run Last

Since 0.15.5