Top | ![]() |
![]() |
![]() |
![]() |
gchar * | name | Read / Write / Construct Only |
WockyPubsubService * | service | Read / Write / Construct Only |
GBoxed ╰── WockyPubsubAffiliation GEnum ╰── WockyPubsubAffiliationState GObject ╰── WockyPubsubNode
WockyStanza * wocky_pubsub_node_make_publish_stanza (WockyPubsubNode *self
,WockyNode **pubsub_out
,WockyNode **publish_out
,WockyNode **item_out
);
void wocky_pubsub_node_subscribe_async (WockyPubsubNode *self
,const gchar *jid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Attempts to subscribe to self
.
WockyPubsubSubscription * wocky_pubsub_node_subscribe_finish (WockyPubsubNode *self
,GAsyncResult *result
,GError **error
);
void wocky_pubsub_node_unsubscribe_async (WockyPubsubNode *self
,const gchar *jid
,const gchar *subid
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Attempts to unsubscribe from self
.
self |
a pubsub node |
|
jid |
the JID subscribed to |
|
subid |
the identifier associated with the subscription |
|
cancellable |
optional GCancellable object, |
|
callback |
a callback to call when the request is completed |
|
user_data |
data to pass to |
gboolean wocky_pubsub_node_unsubscribe_finish (WockyPubsubNode *self
,GAsyncResult *result
,GError **error
);
void wocky_pubsub_node_delete_async (WockyPubsubNode *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
gboolean wocky_pubsub_node_delete_finish (WockyPubsubNode *self
,GAsyncResult *result
,GError **error
);
void wocky_pubsub_node_list_subscribers_async (WockyPubsubNode *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Retrieves the list of subscriptions to a node you own. callback
may
complete the call using wocky_pubsub_node_list_subscribers_finish()
.
(A note on naming: this is §8.8.1 — Retrieve Subscriptions List — in XEP-0060, not to be confused with §5.6 — Retrieve Subscriptions. The different terminology in Wocky is intended to help disambiguate!)
self |
a pubsub node |
|
cancellable |
optional GCancellable object |
|
callback |
function to call when the subscribers have been retrieved or an error has occured |
|
user_data |
data to pass to |
gboolean wocky_pubsub_node_list_subscribers_finish (WockyPubsubNode *self
,GAsyncResult *result
,GList **subscribers
,GError **error
);
Completes a call to wocky_pubsub_node_list_subscribers_async()
. The list
returned in subscribers
should be freed with
wocky_pubsub_subscription_list_free()
when it is no longer needed.
self |
a pubsub node |
|
result |
the result passed to a callback |
|
subscribers |
location at which to store a list of WockyPubsubSubscription
pointers, or |
|
error |
location at which to store an error, or |
WockyPubsubAffiliation * wocky_pubsub_affiliation_new (WockyPubsubNode *node
,const gchar *jid
,WockyPubsubAffiliationState state
);
a new structure representing an affiliation, which should
ultimately be freed with wocky_pubsub_affiliation_free()
WockyPubsubAffiliation *
wocky_pubsub_affiliation_copy (WockyPubsubAffiliation *aff
);
a duplicate of aff
; the duplicate should ultimately be freed
with wocky_pubsub_affiliation_free()
void
wocky_pubsub_affiliation_free (WockyPubsubAffiliation *aff
);
Frees an affiliation, previously allocated with
wocky_pubsub_affiliation_new()
or wocky_pubsub_affiliation_copy()
GList *
wocky_pubsub_affiliation_list_copy (GList *affs
);
Shorthand for manually copying affs
, duplicating each element with
wocky_pubsub_affiliation_copy()
.
a deep copy of affs
, which should ultimately be freed with
wocky_pubsub_affiliation_list_free()
.
void
wocky_pubsub_affiliation_list_free (GList *affs
);
Frees a list of WockyPubsubAffiliation structures, as shorthand for calling
wocky_pubsub_affiliation_free()
for each element, followed by g_list_free()
.
void wocky_pubsub_node_list_affiliates_async (WockyPubsubNode *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Retrieves the list of entities affilied to a node you own. callback
may
complete the call using wocky_pubsub_node_list_affiliates_finish()
.
(A note on naming: this is §8.9.1 — Retrieve Affiliations List — in XEP-0060, not to be confused with §5.7 — Retrieve Affiliations. The slightly different terminology in Wocky is intended to help disambiguate!)
self |
a pubsub node |
|
cancellable |
optional GCancellable object |
|
callback |
function to call when the affiliates have been retrieved or an error has occured |
|
user_data |
data to pass to |
gboolean wocky_pubsub_node_list_affiliates_finish (WockyPubsubNode *self
,GAsyncResult *result
,GList **affiliates
,GError **error
);
Completes a call to wocky_pubsub_node_list_affiliates_async()
. The list
returned in affiliates
should be freed with
wocky_pubsub_affiliation_list_free()
when it is no longer needed.
self |
a pubsub node |
|
result |
the result passed to a callback |
|
affiliates |
location at which to store a list of WockyPubsubAffiliation
pointers, or |
|
error |
location at which to store an error, or |
void wocky_pubsub_node_modify_affiliates_async (WockyPubsubNode *self
,GList *affiliates
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Modifies the entities affiliated to a node that you own.
self |
a pubsub node |
|
affiliates |
a list of WockyPubsubAffiliation structures, describing only the affiliations which should be changed. |
|
cancellable |
optional GCancellable object, |
|
callback |
a callback to call when the request is completed |
|
user_data |
data to pass to |
gboolean wocky_pubsub_node_modify_affiliates_finish (WockyPubsubNode *self
,GAsyncResult *result
,GError **error
);
Complete a call to wocky_pubsub_node_modify_affiliates_async()
.
void wocky_pubsub_node_get_configuration_async (WockyPubsubNode *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Retrieves the current configuration for a node owned by the user.
self |
a node |
|
cancellable |
optional GCancellable object, |
|
callback |
a callback to call when the request is completed |
|
user_data |
data to pass to |
WockyDataForm * wocky_pubsub_node_get_configuration_finish (WockyPubsubNode *self
,GAsyncResult *result
,GError **error
);
Complete a call to wocky_pubsub_node_get_configuration_async()
.
Possible affiliations to a PubSub node, which determine privileges an entity has. See XEP-0060 §4.1 for the details.
“name”
property“name” gchar *
The name of the pubsub node.
Flags: Read / Write / Construct Only
Default value: NULL
“service”
property“service” WockyPubsubService *
the Wocky Pubsub service associated with this pubsub node.
Flags: Read / Write / Construct Only
“deleted”
signalvoid user_function (WockyPubsubNode *node, WockyStanza *stanza, gpointer event_node, gpointer delete_node, gpointer user_data)
Emitted when a notification of this node's deletion is received from the server.
node |
a pubsub node |
|
stanza |
the message/event stanza in its entirety |
|
event_node |
the event node from |
|
delete_node |
the delete node from |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“event-received”
signalvoid user_function (WockyPubsubNode *node, WockyStanza *event_stanza, gpointer event_node, gpointer items_node, gpointer items, gpointer user_data)
“subscription-state-changed”
signalvoid user_function (WockyPubsubNode *node, WockyStanza *stanza, gpointer event_node, gpointer subscription_node, WockyPubsubSubscription *subscription, gpointer user_data)
node |
a pubsub node |
|
stanza |
the message/event stanza in its entirety |
|
event_node |
the event node from |
|
subscription_node |
the subscription node from |
|
subscription |
subscription information parsed from |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last