WockyBareContact

WockyBareContact — Wrapper around a roster item.

Synopsis


#include <wocky/wocky-bare-contact.h>

                    WockyBareContact;
                    WockyBareContactClass;
WockyBareContact *  wocky_bare_contact_new              (const gchar *jid);
const gchar *       wocky_bare_contact_get_jid          (WockyBareContact *contact);
const gchar *       wocky_bare_contact_get_name         (WockyBareContact *contact);
void                wocky_bare_contact_set_name         (WockyBareContact *contact,
                                                         const gchar *name);
WockyRosterSubscriptionFlags  wocky_bare_contact_get_subscription
                                                        (WockyBareContact *contact);
void                wocky_bare_contact_set_subscription (WockyBareContact *contact,
                                                         WockyRosterSubscriptionFlags subscription);
void                wocky_bare_contact_set_groups       (WockyBareContact *contact,
                                                         gchar **groups);
gboolean            wocky_bare_contact_equal            (WockyBareContact *a,
                                                         WockyBareContact *b);
void                wocky_bare_contact_add_group        (WockyBareContact *contact,
                                                         const gchar *group);
WockyBareContact *  wocky_bare_contact_copy             (WockyBareContact *contact);
void                wocky_bare_contact_debug_print      (WockyBareContact *contact);
gboolean            wocky_bare_contact_in_group         (WockyBareContact *contact,
                                                         const gchar *group);
void                wocky_bare_contact_remove_group     (WockyBareContact *contact,
                                                         const gchar *group);
void                wocky_bare_contact_add_resource     (WockyBareContact *contact,
                                                         WockyResourceContact *resource);
GSList *            wocky_bare_contact_get_resources    (WockyBareContact *contact);

Object Hierarchy

  GObject
   +----WockyContact
         +----WockyBareContact

Properties

  "groups"                   GStrv*                : Read / Write / Construct
  "jid"                      gchar*                : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct
  "subscription"             guint                 : Read / Write / Construct

Description

Stores information regarding a roster item and provides a higher level API for altering its details.

Details

WockyBareContact

typedef struct _WockyBareContact WockyBareContact;

WockyBareContactClass

typedef struct {
  WockyContactClass parent_class;
} WockyBareContactClass;

wocky_bare_contact_new ()

WockyBareContact *  wocky_bare_contact_new              (const gchar *jid);

jid :

Returns :

wocky_bare_contact_get_jid ()

const gchar *       wocky_bare_contact_get_jid          (WockyBareContact *contact);

contact :

 a WockyBareContact instance

Returns :

 contact's JID.

wocky_bare_contact_get_name ()

const gchar *       wocky_bare_contact_get_name         (WockyBareContact *contact);

contact :

 WockyBareContact instance

Returns :

 contact's name

wocky_bare_contact_set_name ()

void                wocky_bare_contact_set_name         (WockyBareContact *contact,
                                                         const gchar *name);

Sets contact's name to name.

contact :

 a WockyBareContact instance

name :

 the name to set contact

wocky_bare_contact_get_subscription ()

WockyRosterSubscriptionFlags  wocky_bare_contact_get_subscription
                                                        (WockyBareContact *contact);

contact :

 a WockyBareContact instance

Returns :

 contact's subscription.

wocky_bare_contact_set_subscription ()

void                wocky_bare_contact_set_subscription (WockyBareContact *contact,
                                                         WockyRosterSubscriptionFlags subscription);

Sets the subscription of contact.

contact :

 a WockyBareContact instance

subscription :

 the new subscription type

wocky_bare_contact_set_groups ()

void                wocky_bare_contact_set_groups       (WockyBareContact *contact,
                                                         gchar **groups);

Sets contact's groups.

contact :

 a WockyBareContact instance

groups :

 a list of groups

wocky_bare_contact_equal ()

gboolean            wocky_bare_contact_equal            (WockyBareContact *a,
                                                         WockyBareContact *b);

a :

b :

Returns :

wocky_bare_contact_add_group ()

void                wocky_bare_contact_add_group        (WockyBareContact *contact,
                                                         const gchar *group);

contact :

group :

wocky_bare_contact_copy ()

WockyBareContact *  wocky_bare_contact_copy             (WockyBareContact *contact);

contact :

Returns :

wocky_bare_contact_debug_print ()

void                wocky_bare_contact_debug_print      (WockyBareContact *contact);

contact :

wocky_bare_contact_in_group ()

gboolean            wocky_bare_contact_in_group         (WockyBareContact *contact,
                                                         const gchar *group);

contact :

group :

Returns :

wocky_bare_contact_remove_group ()

void                wocky_bare_contact_remove_group     (WockyBareContact *contact,
                                                         const gchar *group);

contact :

group :

wocky_bare_contact_add_resource ()

void                wocky_bare_contact_add_resource     (WockyBareContact *contact,
                                                         WockyResourceContact *resource);

contact :

resource :

wocky_bare_contact_get_resources ()

GSList *            wocky_bare_contact_get_resources    (WockyBareContact *contact);

contact :

Returns :

Property Details

The "groups" property

  "groups"                   GStrv*                : Read / Write / Construct

A list of the contact's groups, according to the roster.

The "jid" property

  "jid"                      gchar*                : Read / Write / Construct Only

The contact's bare JID, according to the roster.

Default value: ""

The "name" property

  "name"                     gchar*                : Read / Write / Construct

The contact's name, according to the roster.

Default value: ""

The "subscription" property

  "subscription"             guint                 : Read / Write / Construct

The subscription type of the contact, according to the roster.

Allowed values: <= 3

Default value: 0

Generated by GTK-Doc V1.11