TplEntity

TplEntity — Representation of a contact or chatroom

Synopsis

enum                TplEntityType;
                    TplEntityPriv;
const gchar *       tpl_entity_get_alias                (TplEntity *self);
const gchar *       tpl_entity_get_identifier           (TplEntity *self);
TplEntityType       tpl_entity_get_entity_type          (TplEntity *self);
const gchar *       tpl_entity_get_avatar_token         (TplEntity *self);

Description

An object representing a contact or chatroom.

Details

enum TplEntityType

typedef enum
{
  TPL_ENTITY_UNKNOWN,
  /* contact is a user (buddy) */
  TPL_ENTITY_CONTACT,
  /* contact is a chatroom, meaning that the related message has been sent to
   * a chatroom instead of to a 1-1 channel */
  TPL_ENTITY_GROUP,
  /* contact is both a USER and the account's owner (self-handle) */
  TPL_ENTITY_SELF
} TplEntityType;


TplEntityPriv

typedef struct _TplEntityPriv TplEntityPriv;


tpl_entity_get_alias ()

const gchar *       tpl_entity_get_alias                (TplEntity *self);

self :

a TplEntity

Returns :

the alias of the entity, or NULL

tpl_entity_get_identifier ()

const gchar *       tpl_entity_get_identifier           (TplEntity *self);

self :

a TplEntity

Returns :

the identifier of the entity

tpl_entity_get_entity_type ()

TplEntityType       tpl_entity_get_entity_type          (TplEntity *self);

self :

a TplEntity

Returns :

the type of the entity

tpl_entity_get_avatar_token ()

const gchar *       tpl_entity_get_avatar_token         (TplEntity *self);

self :

a TplEntity

Returns :

a token representing the avatar of the token, or NULL