tp_base_protocol_get_name ()

const gchar *
tp_base_protocol_get_name (TpBaseProtocol *self);

Since 0.11.11

tp_base_protocol_get_immutable_properties ()

GHashTable *
tp_base_protocol_get_immutable_properties
                               (TpBaseProtocol *self);

Return a basic set of immutable properties for this Protocol object, by using tp_dbus_properties_mixin_make_properties_hash().

Additional keys and values can be inserted into the returned hash table; if this is done, the inserted keys and values will be freed when the hash table is destroyed. The keys must be allocated with g_strdup() or equivalent, and the values must be slice-allocated (for instance with tp_g_value_slice_new_string() or a similar function).

Note that in particular, tp_asv_set_string() and similar functions should not be used with this hash table.

Since 0.11.11

tp_base_protocol_get_parameters ()

const TpCMParamSpec *
tp_base_protocol_get_parameters (TpBaseProtocol *self);

Returns the parameters supported by this protocol, as an array of structs which must remain valid at least as long as self exists (it will typically be a global static array).

Since 0.11.11

tp_base_protocol_get_statuses ()

const TpPresenceStatusSpec *
tp_base_protocol_get_statuses (TpBaseProtocol *self);

Get the statuses supported by this object. Subclasses implement this via the TpBaseProtocolClass.get_statuses virtual method.

If the object does not implement the Protocol.Interface.Presences interface, it need not implement this virtual method.

Since 0.13.5

tp_base_protocol_new_connection ()

TpBaseConnection *
tp_base_protocol_new_connection (TpBaseProtocol *self,
                                 GHashTable *asv,
                                 GError **error);

Create a new connection using the TpBaseProtocolClass.get_parameters and TpBaseProtocolClass.new_connection implementations provided by a subclass. This is used to implement the RequestConnection() D-Bus method.

If the parameters in asv do not fit the result of get_parameters (unknown parameters are given, types are inappropriate, required parameters are not given, or a TpCMParamSpec.filter fails), then this method raises an error and new_connection is not called.

Otherwise, new_connection is called. Its asv argument is a copy of the asv given to this method, with default values for missing parameters filled in where available, and parameters' types converted to the GType specified by TpCMParamSpec.gtype.

Since 0.11.11

TpBaseProtocolGetParametersFunc ()

const TpCMParamSpec *
(*TpBaseProtocolGetParametersFunc) (TpBaseProtocol *self);

Signature of a virtual method to get the allowed parameters for connections to a protocol.

Returns the parameters supported by this protocol, as an array of structs which must remain valid at least as long as self exists (it will typically be a global static array).

Since 0.11.11

TpBaseProtocolNewConnectionFunc ()

TpBaseConnection *
(*TpBaseProtocolNewConnectionFunc) (TpBaseProtocol *self,
                                    GHashTable *asv,
                                    GError **error);

Signature of a virtual method to create a new connection to this protocol. This is used to implement the RequestConnection D-Bus method.

Implementations of TpBaseProtocolClass.new_connection may assume that the parameters in asv conform to the specifications given by TpBaseProtocolClass.get_parameters.

Since 0.11.11

TpBaseProtocolNormalizeContactFunc ()

gchar *
(*TpBaseProtocolNormalizeContactFunc) (TpBaseProtocol *self,
                                       const gchar *contact,
                                       GError **error);

Signature of a virtual method to perform best-effort offline normalization of a contact's identifier. It must either return a newly allocated string that is the normalized form of contact , or raise an error and return NULL.

Since 0.11.11

TpBaseProtocolIdentifyAccountFunc ()

gchar *
(*TpBaseProtocolIdentifyAccountFunc) (TpBaseProtocol *self,
                                      GHashTable *asv,
                                      GError **error);

Signature of a virtual method to choose a unique name for an account whose connection parameters are asv . This will typically return a copy of the 'account' parameter from asv , but may do something more complex (for instance, on IRC it could combine the nickname and the IRC network).

Implementations of TpBaseProtocolClass.identify_account may assume that the parameters in asv conform to the specifications given by TpBaseProtocolClass.get_parameters.

Since 0.11.11

TpBaseProtocolGetConnectionDetailsFunc ()

void
(*TpBaseProtocolGetConnectionDetailsFunc)
                               (TpBaseProtocol *self,
                                GStrv *connection_interfaces,
                                GType **channel_manager_types,
                                gchar **icon_name,
                                gchar **english_name,
                                gchar **vcard_field);

Signature of a virtual method to get the D-Bus interfaces implemented by self , in addition to the Protocol interface.

Since 0.11.11

TpBaseProtocolGetAvatarDetailsFunc ()

void
(*TpBaseProtocolGetAvatarDetailsFunc) (TpBaseProtocol *self,
                                       GStrv *supported_mime_types,
                                       guint *min_height,
                                       guint *min_width,
                                       guint *rec_height,
                                       guint *rec_width,
                                       guint *max_height,
                                       guint *max_width,
                                       guint *max_bytes);

Signature of a virtual method to get the supported avatar details for the protocol implemented by self .

Since 0.13.7

TpBaseProtocolDupSupportedVCardFieldsFunc ()

GStrv
(*TpBaseProtocolDupSupportedVCardFieldsFunc)
                               (TpBaseProtocol *self);

Signature of a virtual method to get the supported vCard fields supported by self.

Since 0.17.2

TpBaseProtocolDupSupportedURISchemesFunc ()

GStrv
(*TpBaseProtocolDupSupportedURISchemesFunc)
                               (TpBaseProtocol *self);

Signature of a virtual method to get the supported URI schemes supported by self.

Since 0.17.2

TpBaseProtocolNormalizeVCardAddressFunc ()

gchar *
(*TpBaseProtocolNormalizeVCardAddressFunc)
                               (TpBaseProtocol *self,
                                const gchar *vcard_field,
                                const gchar *vcard_address,
                                GError **error);

Signature of a virtual method to perform best-effort offline normalization of a vCard address. It must either return a newly allocated string that is the normalized form of vcard_address , or raise an error and return NULL.

Since 0.17.2

TpBaseProtocolNormalizeURIFunc ()

gchar *
(*TpBaseProtocolNormalizeURIFunc) (TpBaseProtocol *self,
                                   const gchar *uri,
                                   GError **error);

Signature of a virtual method to perform best-effort offline normalization of a URI. It must either return a newly allocated string that is the normalized form of uri , or raise an error and return NULL.

Since 0.13.11

struct TpBaseProtocol

struct TpBaseProtocol;

An object providing static details of the implementation of one real-time communications protocol.

Since 0.11.11

struct TpBaseProtocolClass

struct TpBaseProtocolClass {
  GDBusObjectSkeletonClass parent_class;

  gboolean is_stub;
  const TpCMParamSpec *(*get_parameters) (TpBaseProtocol *self);
  TpBaseConnection *(*new_connection) (TpBaseProtocol *self,
      GHashTable *asv,
      GError **error);

  gchar *(*normalize_contact) (TpBaseProtocol *self,
      const gchar *contact,
      GError **error);
  gchar *(*identify_account) (TpBaseProtocol *self,
      GHashTable *asv,
      GError **error);

  void (*get_connection_details) (TpBaseProtocol *self,
      GStrv *connection_interfaces,
      GType **channel_manager_types,
      gchar **icon_name,
      gchar **english_name,
      gchar **vcard_field);

  const TpPresenceStatusSpec * (*get_statuses) (TpBaseProtocol *self);

  TpBaseProtocolGetAvatarDetailsFunc get_avatar_details;

  GStrv (*dup_authentication_types) (TpBaseProtocol *self);
};

The class of a TpBaseProtocol.

Since 0.11.11

struct TpProtocolAddressingInterface

struct TpProtocolAddressingInterface {
  GTypeInterface parent;

  TpBaseProtocolDupSupportedVCardFieldsFunc dup_supported_vcard_fields;

  TpBaseProtocolDupSupportedURISchemesFunc dup_supported_uri_schemes;

  TpBaseProtocolNormalizeVCardAddressFunc normalize_vcard_address;

  TpBaseProtocolNormalizeURIFunc normalize_contact_uri;
};

The interface vtable for a TP_TYPE_PROTOCOL_ADDRESSING.

Since 0.17.2

The “immutable-properties” property

  “immutable-properties”     GHashTable_gchararray+GValue_*

The D-Bus properties to be announced in the ConnectionManager interface's Protocols property, as a map from interface.name.propertyname to GValue.

A protocol's immutable properties are constant for its lifetime on the bus, so this property should never change. All of the D-Bus properties mentioned here should also be exposed through the D-Bus properties interface.

The TpBaseProtocol base class implements this property to be correct for the basic set of properties. It can be reimplemented by subclasses to have more immutable properties; if so, the subclass should use tp_base_protocol_get_immutable_properties(), then augment the result using tp_dbus_properties_mixin_fill_properties_hash().

Flags: Read

Since 0.11.11

The “name” property

  “name”                     gchar *

The Protocol from telepathy-spec, such as 'jabber' or 'local-xmpp'.

Flags: Read / Write / Construct Only

Default value: NULL