| Wocky Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
WockyRoster; WockyRosterClass; WockyRosterPrivate; GQuark wocky_roster_error_quark (void); enum WockyRosterSubscriptionFlags; enum WockyRosterError; #define WOCKY_ROSTER_ERROR WockyRoster * wocky_roster_new (WockySession *session); void wocky_roster_fetch_roster_async (WockyRoster *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean wocky_roster_fetch_roster_finish (WockyRoster *self,GAsyncResult *result,GError **error); WockyBareContact * wocky_roster_get_contact (WockyRoster *self,const gchar *jid); GSList * wocky_roster_get_all_contacts (WockyRoster *self); void wocky_roster_add_contact_async (WockyRoster *self,const gchar *jid,const gchar *name,const gchar * const *groups,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean wocky_roster_add_contact_finish (WockyRoster *self,GAsyncResult *result,GError **error); void wocky_roster_remove_contact_async (WockyRoster *self,WockyBareContact *contact,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean wocky_roster_remove_contact_finish (WockyRoster *self,GAsyncResult *result,GError **error); void wocky_roster_change_contact_name_async (WockyRoster *self,WockyBareContact *contact,const gchar *name,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean wocky_roster_change_contact_name_finish (WockyRoster *self,GAsyncResult *result,GError **error); void wocky_roster_contact_add_group_async (WockyRoster *self,WockyBareContact *contact,const gchar *group,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean wocky_roster_contact_add_group_finish (WockyRoster *self,GAsyncResult *result,GError **error); void wocky_roster_contact_remove_group_async (WockyRoster *self,WockyBareContact *contact,const gchar *group,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data); gboolean wocky_roster_contact_remove_group_finish (WockyRoster *self,GAsyncResult *result,GError **error); const gchar * wocky_roster_subscription_to_string (WockyRosterSubscriptionFlags subscription);
GQuark wocky_roster_error_quark (void);
Get the error quark used by the roster.
Returns : |
the quark for roster errors. |
typedef enum
{
WOCKY_ROSTER_SUBSCRIPTION_TYPE_NONE = 0,
WOCKY_ROSTER_SUBSCRIPTION_TYPE_TO = 1 << 0,
WOCKY_ROSTER_SUBSCRIPTION_TYPE_FROM = 1 << 1,
WOCKY_ROSTER_SUBSCRIPTION_TYPE_BOTH =
WOCKY_ROSTER_SUBSCRIPTION_TYPE_TO | WOCKY_ROSTER_SUBSCRIPTION_TYPE_FROM,
/*< private >*/
LAST_WOCKY_ROSTER_SUBSCRIPTION_TYPE = WOCKY_ROSTER_SUBSCRIPTION_TYPE_BOTH
} WockyRosterSubscriptionFlags;
Flags to document the subscription information between contacts.
| the user does not have a subscription to the contact's presence information, and the contact does not have a subscription to the user's presence information | |
| the user has a subscription to the contact's presence information, but the contact does not have a subscription to the user's presence information | |
| the contact has a subscription to the user's presence information, but the user does not have a subscription to the contact's presence information | |
| both the user and the contact have subscriptions to each other's presence information |
typedef enum {
WOCKY_ROSTER_ERROR_INVALID_STANZA,
WOCKY_ROSTER_ERROR_NOT_IN_ROSTER,
} WockyRosterError;
The WockyRosterError specific errors.
#define WOCKY_ROSTER_ERROR (wocky_roster_error_quark ())
Get access to the error quark of the roster.
void wocky_roster_fetch_roster_async (WockyRoster *self,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
|
|
|
|
|
|
|
gboolean wocky_roster_fetch_roster_finish (WockyRoster *self,GAsyncResult *result,GError **error);
|
|
|
|
|
|
Returns : |
WockyBareContact * wocky_roster_get_contact (WockyRoster *self,const gchar *jid);
|
|
|
|
Returns : |
GSList * wocky_roster_get_all_contacts (WockyRoster *self);
|
|
Returns : |
void wocky_roster_add_contact_async (WockyRoster *self,const gchar *jid,const gchar *name,const gchar * const *groups,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
|
|
|
|
|
|
|
|
|
|
|
|
|
gboolean wocky_roster_add_contact_finish (WockyRoster *self,GAsyncResult *result,GError **error);
|
|
|
|
|
|
Returns : |
void wocky_roster_remove_contact_async (WockyRoster *self,WockyBareContact *contact,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
|
|
|
|
|
|
|
|
|
gboolean wocky_roster_remove_contact_finish (WockyRoster *self,GAsyncResult *result,GError **error);
|
|
|
|
|
|
Returns : |
void wocky_roster_change_contact_name_async (WockyRoster *self,WockyBareContact *contact,const gchar *name,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
|
|
|
|
|
|
|
|
|
|
|
gboolean wocky_roster_change_contact_name_finish (WockyRoster *self,GAsyncResult *result,GError **error);
|
|
|
|
|
|
Returns : |
void wocky_roster_contact_add_group_async (WockyRoster *self,WockyBareContact *contact,const gchar *group,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
|
|
|
|
|
|
|
|
|
|
|
gboolean wocky_roster_contact_add_group_finish (WockyRoster *self,GAsyncResult *result,GError **error);
|
|
|
|
|
|
Returns : |
void wocky_roster_contact_remove_group_async (WockyRoster *self,WockyBareContact *contact,const gchar *group,GCancellable *cancellable,GAsyncReadyCallback callback,gpointer user_data);
|
|
|
|
|
|
|
|
|
|
|
gboolean wocky_roster_contact_remove_group_finish (WockyRoster *self,GAsyncResult *result,GError **error);
|
|
|
|
|
|
Returns : |
const gchar * wocky_roster_subscription_to_string (WockyRosterSubscriptionFlags subscription);
|
|
Returns : |
"session" property"session" WockySession* : Read / Write / Construct Only
the wocky session used by this roster.
"added" signalvoid user_function (WockyRoster *wockyroster, GObject *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"removed" signalvoid user_function (WockyRoster *wockyroster, GObject *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |