struct TpProtocol

struct TpProtocol;

A base class for connection managers' protocols.

Since 0.11.11

TpProtocolClass

typedef struct _TpProtocolClass TpProtocolClass;

The class of a TpProtocol.

Since 0.11.11

tp_protocol_new ()

TpProtocol *        tp_protocol_new                     (TpDBusDaemon *dbus,
                                                         const gchar *cm_name,
                                                         const gchar *protocol_name,
                                                         const GHashTable *immutable_properties,
                                                         GError **error);

Since 0.11.11

tp_protocol_new_vardict ()

TpProtocol *        tp_protocol_new_vardict             (TpDBusDaemon *dbus,
                                                         const gchar *cm_name,
                                                         const gchar *protocol_name,
                                                         GVariant *immutable_properties,
                                                         GError **error);

Create a new protocol proxy.

If immutable_properties is a floating reference, this function will take ownership of it, much like g_variant_ref_sink(). See documentation of that function for details.

Since 0.23.3

tp_protocol_get_name ()

const gchar *       tp_protocol_get_name                (TpProtocol *self);

Return the same thing as the protocol-name property, for convenient use in C code. The returned string is valid for as long as self exists.

Since 0.11.11

tp_protocol_get_cm_name ()

const gchar *       tp_protocol_get_cm_name             (TpProtocol *self);

Return the "cm-name" property.

Since 0.19.1

tp_protocol_init_known_interfaces ()

void                tp_protocol_init_known_interfaces   (void);

Ensure that the known interfaces for TpProtocol 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_PROTOCOL.

Since 0.11.11

TP_PROTOCOL_FEATURE_PARAMETERS

#define             TP_PROTOCOL_FEATURE_PARAMETERS

Expands to a call to a function that returns a quark for the parameters feature of a TpProtocol.

When this feature is prepared, the possible parameters for connections to this protocol have been retrieved and are available for use.

Unlike TP_PROTOCOL_FEATURE_CORE, this feature can even be available on connection managers that don't really have Protocol objects (on these older connection managers, the TpProtocol uses information from ConnectionManager methods to provide the list of parameters).

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

tp_protocol_borrow_params ()

const TpConnectionManagerParam * tp_protocol_borrow_params
                                                        (TpProtocol *self);

Returns an array of parameters supported by this connection manager, without additional memory allocations. The returned array is owned by self, and must not be used after self has been freed.

Since 0.17.6

tp_protocol_dup_params ()

GList *             tp_protocol_dup_params              (TpProtocol *self);

Returns a list of parameters supported by this connection manager.

The returned list must be freed by the caller, for instance with g_list_free_full (l, (GDestroyNotify) tp_connection_manager_param_free).

Since 0.17.6

tp_protocol_dup_param_names ()

GStrv               tp_protocol_dup_param_names         (TpProtocol *self);

Returns a list of parameter names supported by this connection manager for this protocol.

The result is copied and must be freed by the caller with g_strfreev().

Since 0.11.11

tp_protocol_get_param ()

const TpConnectionManagerParam * tp_protocol_get_param  (TpProtocol *self,
                                                         const gchar *param);

Since 0.11.11

tp_protocol_dup_param ()

TpConnectionManagerParam * tp_protocol_dup_param        (TpProtocol *self,
                                                         const gchar *param);

Since 0.17.6

tp_protocol_has_param ()

gboolean            tp_protocol_has_param               (TpProtocol *self,
                                                         const gchar *param);

Since 0.11.11

tp_protocol_can_register ()

gboolean            tp_protocol_can_register            (TpProtocol *self);

Return whether a new account can be registered on this protocol, by setting the special "register" parameter to TRUE.

Since 0.11.11

tp_protocol_dup_immutable_properties ()

GVariant *          tp_protocol_dup_immutable_properties
                                                        (TpProtocol *self);

Return the "protocol-properties-vardict" property.

Since 0.23.3

TP_PROTOCOL_FEATURE_CORE

#define             TP_PROTOCOL_FEATURE_CORE

Expands to a call to a function that returns a quark for the core feature of a TpProtocol.

When this feature is prepared, at least the following basic information about the protocol is available:

(This feature implies that TP_PROTOCOL_FEATURE_PARAMETERS is also available.)

Unlike TP_PROTOCOL_FEATURE_PARAMETERS, this feature can only become available on connection managers that implement Protocol objects.

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

tp_protocol_get_capabilities ()

TpCapabilities *    tp_protocol_get_capabilities        (TpProtocol *self);

Since 0.11.11

tp_protocol_get_english_name ()

const gchar *       tp_protocol_get_english_name        (TpProtocol *self);

Since 0.11.11

tp_protocol_get_icon_name ()

const gchar *       tp_protocol_get_icon_name           (TpProtocol *self);

Since 0.11.11

tp_protocol_get_vcard_field ()

const gchar *       tp_protocol_get_vcard_field         (TpProtocol *self);

Since 0.11.11

tp_protocol_get_authentication_types ()

const gchar * const * tp_protocol_get_authentication_types
                                                        (TpProtocol *self);

Since 0.13.9

tp_protocol_identify_account_async ()

void                tp_protocol_identify_account_async  (TpProtocol *self,
                                                         GVariant *vardict,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Return a string that could identify the account with the given parameters. In most protocols that string is a normalized 'account' parameter, but some protocols have more complex requirements; for instance, on IRC, the 'account' (nickname) is insufficient, and must be combined with a server or network name.

Since 0.23.1

tp_protocol_identify_account_finish ()

gchar *             tp_protocol_identify_account_finish (TpProtocol *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Interpret the result of tp_protocol_identify_account_async().

Since 0.23.1

tp_protocol_normalize_contact_async ()

void                tp_protocol_normalize_contact_async (TpProtocol *self,
                                                         const gchar *contact,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Perform best-effort offline contact normalization. This does syntactic normalization (e.g. transforming case-insensitive text to lower-case), but does not query servers or anything similar.

Since 0.23.1

tp_protocol_normalize_contact_finish ()

gchar *             tp_protocol_normalize_contact_finish
                                                        (TpProtocol *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Interpret the result of tp_protocol_normalize_contact_async().

Since 0.23.1

tp_protocol_get_avatar_requirements ()

TpAvatarRequirements * tp_protocol_get_avatar_requirements
                                                        (TpProtocol *self);

Return the "avatar-requirements" property

Since 0.15.6

tp_protocol_dup_presence_statuses ()

GList *             tp_protocol_dup_presence_statuses   (TpProtocol *self);

Return the presence statuses that might be supported by connections to this protocol.

It is possible that some of these statuses will not actually be supported by a connection: for instance, an XMPP connection manager would include "hidden" in this list, even though not all XMPP servers allow users to be online-but-hidden.

tp_protocol_get_addressable_uri_schemes ()

const gchar * const * tp_protocol_get_addressable_uri_schemes
                                                        (TpProtocol *self);

Since 0.23.1

tp_protocol_get_addressable_vcard_fields ()

const gchar * const * tp_protocol_get_addressable_vcard_fields
                                                        (TpProtocol *self);

Since 0.23.1

tp_protocol_normalize_contact_uri_async ()

void                tp_protocol_normalize_contact_uri_async
                                                        (TpProtocol *self,
                                                         const gchar *uri,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Perform best-effort offline contact normalization, for a contact in the form of a URI. This method will fail if the URI is not in a scheme supported by this protocol or connection manager.

Since 0.23.1

tp_protocol_normalize_contact_uri_finish ()

gchar *             tp_protocol_normalize_contact_uri_finish
                                                        (TpProtocol *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Interpret the result of tp_protocol_normalize_contact_uri_async().

Since 0.23.1

tp_protocol_normalize_vcard_address_async ()

void                tp_protocol_normalize_vcard_address_async
                                                        (TpProtocol *self,
                                                         const gchar *field,
                                                         const gchar *value,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Perform best-effort offline contact normalization, for a contact in the form of a vCard field. This method will fail if the vCard field is not supported by this protocol or connection manager.

Since 0.23.1

tp_protocol_normalize_vcard_address_finish ()

gchar *             tp_protocol_normalize_vcard_address_finish
                                                        (TpProtocol *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Interpret the result of tp_protocol_normalize_vcard_address_async().

Since 0.23.1

tp_cli_protocol_call_identify_account ()

TpProxyPendingCall * tp_cli_protocol_call_identify_account
                                                        (gpointer proxy,
                                                         gint timeout_ms,
                                                         GHashTable *in_Parameters,
                                                         tp_cli_protocol_callback_for_identify_account callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a IdentifyAccount method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Return a string which uniquely identifies the account to which the given parameters would connect.</p> <tp:rationale> <p>For many protocols, this would return the well-known 'account' parameter. However, for IRC the returned string would be composed from the 'account' (i.e. nickname) and 'server' parameters. AccountManager implementations can use this to form the account-specific part of an Account's object path.</p> </tp:rationale>

tp_cli_protocol_call_normalize_contact ()

TpProxyPendingCall * tp_cli_protocol_call_normalize_contact
                                                        (gpointer proxy,
                                                         gint timeout_ms,
                                                         const gchar *in_Contact_ID,
                                                         tp_cli_protocol_callback_for_normalize_contact callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a NormalizeContact method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Attempt to normalize the given contact ID. Where possible, this SHOULD return the same thing that would be returned by InspectHandles(RequestHandles(CONTACT, [Contact_ID])) on a connected <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>.</p> <p>If full normalization requires network activity or is otherwise impossible to do without a <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>, this method SHOULD perform a best-effort normalization.</p> <tp:rationale> <p>One common example of a best-effort offline normalization differing from the ideal normalization is XMPP.</p> <p>On XMPP, contacts' JIDs should normally have the resource removed during normalization, but for contacts in a MUC (chatroom), the resource is an integral part of the JID - so the contact JID aliceexample.com/Empathy should normalize to aliceexample.com, but the in-MUC JID wonderlandconference.example.com/Alice should normalize to itself.</p> <p>While online, the connection manager has enough context to know which chatrooms the user is in, and can infer from that whether to remove resources, but the best-effort normalization performed while offline does not have this context, so the best that can be done is to remove the resource from all JIDs.</p> </tp:rationale> <p>This method MAY simply raise NotImplemented on some protocols.</p> <tp:rationale> <p>In link-local XMPP, you can't talk to someone who isn't present on your local network, so normalizing identifiers in advance is meaningless.</p> </tp:rationale>

tp_cli_protocol_callback_for_identify_account ()

void                (*tp_cli_protocol_callback_for_identify_account)
                                                        (TpProxy *proxy,
                                                         const gchar *out_Account_ID,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

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

tp_cli_protocol_callback_for_normalize_contact ()

void                (*tp_cli_protocol_callback_for_normalize_contact)
                                                        (TpProxy *proxy,
                                                         const gchar *out_Normalized_Contact_ID,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

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

tp_cli_protocol_interface_addressing_call_normalize_contact_uri ()

TpProxyPendingCall * tp_cli_protocol_interface_addressing_call_normalize_contact_uri
                                                        (gpointer proxy,
                                                         gint timeout_ms,
                                                         const gchar *in_URI,
                                                         tp_cli_protocol_interface_addressing_callback_for_normalize_contact_uri callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a NormalizeContactURI method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Attempt to normalize the given contact URI. Where possible, this SHOULD return an address that would appear in the <code>org.freedesktop.Telepathy.Connection.Interface.Addressing1/uris</code> attribute for a contact on a connected <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>. </p> <p>If full normalization requires network activity or is otherwise impossible to do without a <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>, this method SHOULD perform a best-effort normalization.</p> <p>If the URI has extra information beyond what's necessary to identify a particular contact, such as an XMPP resource or an action to carry out, this extra information SHOULD be removed. If all URIs in a scheme contain a verb or action (like <code>aim</code>, <code>ymsgr</code> and <code>msnim</code> URIs), then the verb SHOULD be replaced with the one specified in <tp:member-ref>AddressableURISchemes</tp:member-ref>.</p> <tp:rationale> <p>This method is intended to normalize URIs stored in address books, for instance. In protocols like XMPP, if you vary the resource or action (query string), the URI still refers to the same high-level contact.</p> </tp:rationale> <p>For instance, <code>xmpp:romeoExample.Com/Empathy?message;body=Hello</code> would be normalized to <code>xmpp:romeoexample.com</code>, and <code>aim:goim?screenname=Romeo20M&amp;message=Hello</code> would be normalized to <code>aim:addbuddy?screenname=romeom</code>.</p> <p>This method MAY simply raise NotImplemented on some protocols, if it has no use.</p>

tp_cli_protocol_interface_addressing_call_normalize_vcard_address ()

TpProxyPendingCall * tp_cli_protocol_interface_addressing_call_normalize_vcard_address
                                                        (gpointer proxy,
                                                         gint timeout_ms,
                                                         const gchar *in_VCard_Field,
                                                         const gchar *in_VCard_Address,
                                                         tp_cli_protocol_interface_addressing_callback_for_normalize_vcard_address callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a NormalizeVCardAddress method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Attempt to normalize the given vCard address. Where possible, this SHOULD return an address that would appear in the <code>org.freedesktop.Telepathy.Connection.Interface.Addressing1/addresses</code> attribute for a contact on a connected <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>. </p> <p>If full normalization requires network activity or is otherwise impossible to do without a <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>, this method SHOULD perform a best-effort normalization.</p> <p>An example would be a vCard TEL field with a formatted number in the form of <code>+1 (206) 555 1234</code>, this would be normalized to <code>+12065551234</code>.</p> <p>This method MAY simply raise NotImplemented on some protocols, if it has no use.</p>

tp_cli_protocol_interface_addressing_callback_for_normalize_contact_uri ()

void                (*tp_cli_protocol_interface_addressing_callback_for_normalize_contact_uri)
                                                        (TpProxy *proxy,
                                                         const gchar *out_Normalized_URI,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

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

tp_cli_protocol_interface_addressing_callback_for_normalize_vcard_address ()

void                (*tp_cli_protocol_interface_addressing_callback_for_normalize_vcard_address)
                                                        (TpProxy *proxy,
                                                         const gchar *out_Normalized_VCard_Address,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

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

The "addressable-uri-schemes" property

  "addressable-uri-schemes"  GStrv                 : Read

A non-NULL GStrv of URI schemes supported by this protocol. If this protocol does not support addressing contacts by URI, the list is empty.

For instance, a SIP connection manager that supports calling contacts by SIP URI (sip:alice@example.com, sips:bob@example.com) or telephone number (tel:+1-555-0123) might have { "sip", "sips", "tel", NULL }.

Since 0.23.1

The "addressable-vcard-fields" property

  "addressable-vcard-fields" GStrv                 : Read

A non-NULL GStrv of vCard fields supported by this protocol. If this protocol does not support addressing contacts by a vCard field, the list is empty.

For instance, a SIP connection manager that supports calling contacts by SIP URI (vCard field SIP) or telephone number (vCard field TEL) might have { "sip", "tel", NULL }.

Since 0.23.1

The "authentication-types" property

  "authentication-types"     GStrv                 : Read

A non-NULL GStrv of interfaces which provide information as to what kind of authentication channels can possibly appear before the connection reaches the CONNECTED state, or NULL if TP_PROTOCOL_FEATURE_CORE has not been prepared.

Since 0.13.9

The "avatar-requirements" property

  "avatar-requirements"      gpointer              : Read

A TpAvatarRequirements representing the avatar requirements on this protocol, or NULL if TP_PROTOCOL_FEATURE_CORE has not been prepared or if the protocol doesn't support avatars.

Since 0.15.6

The "capabilities" property

  "capabilities"             TpCapabilities*       : Read

The classes of channel that can be requested from connections to this protocol, or NULL if this is unknown or the TP_PROTOCOL_FEATURE_CORE feature has not been prepared.

Since 0.11.11

The "cm-name" property

  "cm-name"                  gchar*                : Read / Write / Construct Only

The name of the connection manager this protocol is on.

Default value: NULL

Since 0.19.1

The "english-name" property

  "english-name"             gchar*                : Read

The name of the protocol in a form suitable for display to users, such as "AIM" or "Yahoo!", or a string based on "protocol-name" (currently constructed by putting the first character in title case, but this is not guaranteed) if no better name is available or the TP_PROTOCOL_FEATURE_CORE feature has not been prepared.

This is effectively in the C locale (international English); user interfaces requiring a localized protocol name should look one up in their own message catalog based on either "protocol-name" or "english-name", but should use this English version as a fallback if no translated version can be found.

Default value: NULL

Since 0.11.11

The "icon-name" property

  "icon-name"                gchar*                : Read

The name of an icon in the system's icon theme. If none was supplied by the Protocol, or the TP_PROTOCOL_FEATURE_CORE feature has not been prepared, a default is used; currently, this is "im-" plus "protocol-name".

Default value: NULL

Since 0.11.11

The "param-names" property

  "param-names"              GStrv                 : Read

A list of parameter names supported by this connection manager for this protocol, or NULL if TP_PROTOCOL_FEATURE_PARAMETERS has not been prepared.

Since 0.11.11

The "protocol-name" property

  "protocol-name"            gchar*                : Read / Write / Construct Only

The machine-readable name of the protocol, taken from the Telepathy D-Bus Interface Specification, such as "jabber" or "local-xmpp".

Default value: NULL

Since 0.11.11

The "protocol-properties" property

  "protocol-properties"      GHashTable_gchararray+GValue_*  : Read / Write / Construct Only

The immutable properties of this Protocol, as provided at construction time. This is a map from string to GValue, which must not be modified.

If the immutable properties were not provided at construction time, the TP_PROTOCOL_FEATURE_PARAMETERS and TP_PROTOCOL_FEATURE_CORE features will both be unavailable, and this TpProtocol object will only be useful as a way to access lower-level D-Bus calls.

Since 0.11.11

The "protocol-properties-vardict" property

  "protocol-properties-vardict" GVariant*             : Read

The immutable properties of this Protocol, as provided at construction time. This is a G_VARIANT_TYPE_VARDICT GVariant, which must not be modified.

If the immutable properties were not provided at construction time, the TP_PROTOCOL_FEATURE_PARAMETERS and TP_PROTOCOL_FEATURE_CORE features will both be unavailable, and this TpProtocol object will only be useful as a way to access lower-level D-Bus calls.

Allowed values: GVariant<a{sv}>

Default value: NULL

Since 0.23.3

The "vcard-field" property

  "vcard-field"              gchar*                : Read

The most common vCard field used for this protocol's contact identifiers, normalized to lower case, or NULL if there is no such field or the TP_PROTOCOL_FEATURE_CORE feature has not been prepared.

Default value: NULL

Since 0.11.11