TpaContactBase

TpaContactBase

Synopsis




#define             TPA_CONTACT_BASE_GET_PRIVATE        (obj)
                    TpaContactBasePrivate;
                    TpaContactBase;
const gchar*        tpa_contact_base_get_avatar_token   (TpaContactBase *self);
TpaContactPresence  tpa_contact_base_get_presence       (TpaContactBase *self);
const gchar*        tpa_contact_base_get_presence_as_string
                                                        (TpaContactBase *self);
const gchar*        tpa_contact_base_get_presence_message
                                                        (TpaContactBase *self);
const gchar*        tpa_contact_base_get_alias          (TpaContactBase *self);
TpaCapability       tpa_contact_base_get_capabilities   (TpaContactBase *self);
TpaAvatar*          tpa_contact_base_get_avatar         (TpaContactBase *self);
gboolean            tpa_contact_base_request_avatar     (TpaContactBase *self);

Object Hierarchy


  GObject
   +----TpaObject
         +----TpaChannelTarget
               +----TpaContactBase
                     +----TpaContact
                     +----TpaUserContact

Signals


  "alias-changed"                                  : Run Last / Has Details
  "avatar-received"                                : Run Last / Has Details
  "avatar-updated"                                 : Run Last / Has Details
  "capabilities-changed"                           : Run Last / Has Details
  "presence-updated"                               : Run Last / Has Details

Description

Details

TPA_CONTACT_BASE_GET_PRIVATE()

#define             TPA_CONTACT_BASE_GET_PRIVATE(obj)

obj :

TpaContactBasePrivate

typedef struct _TpaContactBasePrivate TpaContactBasePrivate;


TpaContactBase

typedef struct _TpaContactBase TpaContactBase;


tpa_contact_base_get_avatar_token ()

const gchar*        tpa_contact_base_get_avatar_token   (TpaContactBase *self);

self :
Returns :

tpa_contact_base_get_presence ()

TpaContactPresence  tpa_contact_base_get_presence       (TpaContactBase *self);

Get contacts presence status.

self : TpaContactBase instance
Returns : TpaContactPresence presence.

tpa_contact_base_get_presence_as_string ()

const gchar*        tpa_contact_base_get_presence_as_string
                                                        (TpaContactBase *self);

Get contacts presence status.

self : TpaContactBase instance
Returns : presence string.

tpa_contact_base_get_presence_message ()

const gchar*        tpa_contact_base_get_presence_message
                                                        (TpaContactBase *self);

Get contacts presence message.

self : TpaContactBase instance
Returns : presence message.

tpa_contact_base_get_alias ()

const gchar*        tpa_contact_base_get_alias          (TpaContactBase *self);

Get contacts alias.

self : TpaContactBase instance
Returns : contact alias.

tpa_contact_base_get_capabilities ()

TpaCapability       tpa_contact_base_get_capabilities   (TpaContactBase *self);

Get contacts capabilities.

self : TpaContactBase instance
Returns : TpaCapability capability.

tpa_contact_base_get_avatar ()

TpaAvatar*          tpa_contact_base_get_avatar         (TpaContactBase *self);

Get contact's avatar.

WARNING: This functions blocks until the avatar is received.

self : TpaContactBase instance
Returns :

tpa_contact_base_request_avatar ()

gboolean            tpa_contact_base_request_avatar     (TpaContactBase *self);

Request contact's avatar.

WARNING: This functions spams threads and has a limit of 32 pending request.

self : TpaContactBase instance
Returns :

Signal Details

The "alias-changed" signal

void                user_function                      (TpaContactBase *tpacontactbase,
                                                        gchar          *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

tpacontactbase : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.

The "avatar-received" signal

void                user_function                      (TpaContactBase *tpacontactbase,
                                                        TpaAvatar      *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

tpacontactbase : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.

The "avatar-updated" signal

void                user_function                      (TpaContactBase *tpacontactbase,
                                                        gchar          *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

tpacontactbase : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.

The "capabilities-changed" signal

void                user_function                      (TpaContactBase *tpacontactbase,
                                                        guint           arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

tpacontactbase : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.

The "presence-updated" signal

void                user_function                      (TpaContactBase *tpacontactbase,
                                                        guint           arg1,
                                                        gchar          *arg2,
                                                        gpointer        user_data)           : Run Last / Has Details

tpacontactbase : the object which received the signal.
arg1 :
arg2 :
user_data : user data set when the signal handler was connected.