![]() |
![]() |
![]() |
wocky Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#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);
"groups" GStrv* : Read / Write / Construct "jid" gchar* : Read / Write / Construct Only "name" gchar* : Read / Write / Construct "subscription" guint : Read / Write / Construct
Stores information regarding a roster item and provides a higher level API for altering its details.
WockyBareContact * wocky_bare_contact_new (const gchar *jid);
Creates a new WockyBareContact for a given JID.
|
the JID of the contact to create |
Returns : |
a newly constructed WockyBareContact |
const gchar * wocky_bare_contact_get_jid (WockyBareContact *contact);
Returns the JID of the contact wrapped by contact
.
|
a WockyBareContact instance |
Returns : |
contact 's JID.
|
const gchar * wocky_bare_contact_get_name (WockyBareContact *contact);
Returns the name of the contact wrapped by contact
.
|
WockyBareContact instance |
Returns : |
contact 's name
|
void wocky_bare_contact_set_name (WockyBareContact *contact, const gchar *name);
Sets contact
's name to name
.
|
a WockyBareContact instance |
|
the name to set contact
|
WockyRosterSubscriptionFlags wocky_bare_contact_get_subscription (WockyBareContact *contact);
Gets the subscription type contact
has.
|
a WockyBareContact instance |
Returns : |
contact 's subscription.
|
void wocky_bare_contact_set_subscription (WockyBareContact *contact, WockyRosterSubscriptionFlags subscription);
Sets the subscription of contact
.
|
a WockyBareContact instance |
|
the new subscription type |
void wocky_bare_contact_set_groups (WockyBareContact *contact, gchar **groups);
Sets contact
's groups.
|
a WockyBareContact instance |
|
a list of groups |
gboolean wocky_bare_contact_equal (WockyBareContact *a, WockyBareContact *b);
Compares whether two WockyBareContact instances refer to the same roster item.
|
a WockyBareContact instance |
|
a WockyBareContact instance to compare with a
|
Returns : |
TRUE if the two contacts match. |
void wocky_bare_contact_add_group (WockyBareContact *contact, const gchar *group);
Adds group
to contact's groups.
|
a WockyBareContact instance |
|
a group |
WockyBareContact * wocky_bare_contact_copy (WockyBareContact *contact);
Convenience function to obtain a copy of the given WockyBareContact.
|
a WockyBareContact instance |
Returns : |
a newly created WockyBareContact which is a copy of the given one. |
void wocky_bare_contact_debug_print (WockyBareContact *contact);
Prints debug information for the given WockyBareContact.
|
a WockyBareContact instance |
gboolean wocky_bare_contact_in_group (WockyBareContact *contact, const gchar *group);
Determines whether the given contact is in group
.
|
a WockyBareContact instance |
|
a group |
Returns : |
TRUE if the contact is in the given group. |
void wocky_bare_contact_remove_group (WockyBareContact *contact, const gchar *group);
Removes group
from the contact's groups.
|
a WockyBareContact instance |
|
a group |
void wocky_bare_contact_add_resource (WockyBareContact *contact, WockyResourceContact *resource);
Adds resource
to the contact's resources.
The WockyBareContact instance doesn't assume a reference to resource
.
|
a WockyBareContact instance |
|
a WockyResourceContact instance |
GSList * wocky_bare_contact_get_resources (WockyBareContact *contact);
Gets a GSList of all the contact's resources. You should call g_slist_free on the list when done with it.
|
a WockyBareContact instance |
Returns : |
a GSList of WockyResourceContact objects. |
"groups"
property"groups" GStrv* : Read / Write / Construct
A list of the contact's groups, according to the roster.
"jid"
property"jid" gchar* : Read / Write / Construct Only
The contact's bare JID, according to the roster.
Default value: ""
"name"
property"name" gchar* : Read / Write / Construct
The contact's name, according to the roster.
Default value: ""
"subscription"
property"subscription" guint : Read / Write / Construct
The subscription type of the contact, according to the roster.
Allowed values: <= 3
Default value: 0