TpaContactList

TpaContactList

Synopsis




#define             TPA_CONTACT_LIST_GET_PRIVATE        (obj)
                    TpaContactListPrivate;
                    TpaContactList;
TpaContact*         tpa_contact_list_add                (TpaContactList *self,
                                                         const gchar *uri);
void                tpa_contact_list_remove             (TpaContactList *self,
                                                         TpaContact *contact);
GPtrArray*          tpa_contact_list_get_known          (TpaContactList *self);
GPtrArray*          tpa_contact_list_get_subscribed     (TpaContactList *self);
GPtrArray*          tpa_contact_list_get_authorized     (TpaContactList *self);
GPtrArray*          tpa_contact_list_get_hidden         (TpaContactList *self);
GPtrArray*          tpa_contact_list_get_blocked        (TpaContactList *self);
TpaContact*         tpa_contact_list_get_contact        (TpaContactList *self,
                                                         const gchar *uri);
gboolean            tpa_contact_list_is_local           (TpaContactList *self);

Object Hierarchy


  GObject
   +----TpaObject
         +----TpaContactList

Properties


  "loaded"                   gboolean              : Write / Construct Only

Signals


  "authorization-requested"                        : Run Last / Has Details
  "loaded"                                         : Run Last / Has Details
  "subscription-accepted"                          : Run Last / Has Details

Description

Details

TPA_CONTACT_LIST_GET_PRIVATE()

#define             TPA_CONTACT_LIST_GET_PRIVATE(obj)

obj :

TpaContactListPrivate

typedef struct _TpaContactListPrivate TpaContactListPrivate;


TpaContactList

typedef struct _TpaContactList TpaContactList;


tpa_contact_list_add ()

TpaContact*         tpa_contact_list_add                (TpaContactList *self,
                                                         const gchar *uri);

Add contact to contact list by its string uri.

self : TpaContactList instance.
uri : Contact uri to be added.
Returns : TpaContact contact added.

tpa_contact_list_remove ()

void                tpa_contact_list_remove             (TpaContactList *self,
                                                         TpaContact *contact);

Removes contact from contact list.

self : TpaContactList instance.
contact :

tpa_contact_list_get_known ()

GPtrArray*          tpa_contact_list_get_known          (TpaContactList *self);

Get contacts all contacts available.

self : TpaContactList instance.
Returns : GPtrArray with known contacts.

tpa_contact_list_get_subscribed ()

GPtrArray*          tpa_contact_list_get_subscribed     (TpaContactList *self);

Get contacts that user is susbscribed to see its presences.

self : TpaContactList instance.
Returns : GPtrArray with susbscribed TpaContact contacts.

tpa_contact_list_get_authorized ()

GPtrArray*          tpa_contact_list_get_authorized     (TpaContactList *self);

Get contacts that are authorized to see user presence.

self : TpaContactList instance.
Returns : GPtrArray with authorized TpaContact contacts.

tpa_contact_list_get_hidden ()

GPtrArray*          tpa_contact_list_get_hidden         (TpaContactList *self);

Get contacts that user is hidden.

self : TpaContactList instance.
Returns : GPtrArray with hidden TpaContact contacts.

tpa_contact_list_get_blocked ()

GPtrArray*          tpa_contact_list_get_blocked        (TpaContactList *self);

Get contacts that are blocked.

self : TpaContactList instance.
Returns : GPtrArray with blocked TpaContact contacts.

tpa_contact_list_get_contact ()

TpaContact*         tpa_contact_list_get_contact        (TpaContactList *self,
                                                         const gchar *uri);

Get contact by its string uri.

self : TpaContactList instance
uri : Given uri.
Returns : TpaContact corresponding to the given uri.

tpa_contact_list_is_local ()

gboolean            tpa_contact_list_is_local           (TpaContactList *self);

self :
Returns :

Property Details

The "loaded" property

  "loaded"                   gboolean              : Write / Construct Only

loaded.

Default value: FALSE

Signal Details

The "authorization-requested" signal

void                user_function                      (TpaContactList *tpacontactlist,
                                                        TpaContact     *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

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

The "loaded" signal

void                user_function                      (TpaContactList *tpacontactlist,
                                                        gpointer        user_data)           : Run Last / Has Details

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

The "subscription-accepted" signal

void                user_function                      (TpaContactList *tpacontactlist,
                                                        TpaContact     *arg1,
                                                        gpointer        user_data)           : Run Last / Has Details

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