WockyPubsubNode

WockyPubsubNode

Functions

Properties

gchar * name Read / Write / Construct Only
WockyPubsubService * service Read / Write / Construct Only

Signals

Types and Values

Object Hierarchy

    GBoxed
    ╰── WockyPubsubAffiliation
    GEnum
    ╰── WockyPubsubAffiliationState
    GObject
    ╰── WockyPubsubNode

Description

Functions

wocky_pubsub_node_get_name ()

const gchar *
wocky_pubsub_node_get_name (WockyPubsubNode *self);

wocky_pubsub_node_make_publish_stanza ()

WockyStanza *
wocky_pubsub_node_make_publish_stanza (WockyPubsubNode *self,
                                       WockyNode **pubsub_out,
                                       WockyNode **publish_out,
                                       WockyNode **item_out);

wocky_pubsub_node_subscribe_async ()

void
wocky_pubsub_node_subscribe_async (WockyPubsubNode *self,
                                   const gchar *jid,
                                   GCancellable *cancellable,
                                   GAsyncReadyCallback callback,
                                   gpointer user_data);

Attempts to subscribe to self .

Parameters

self

a pubsub node

 

jid

the JID to use as the subscribed JID (usually the connection's bare or full JID); may not be NULL

 

cancellable

optional GCancellable object, NULL to ignore

 

callback

a callback to call when the request is completed

 

user_data

data to pass to callback

 

wocky_pubsub_node_subscribe_finish ()

WockyPubsubSubscription *
wocky_pubsub_node_subscribe_finish (WockyPubsubNode *self,
                                    GAsyncResult *result,
                                    GError **error);

wocky_pubsub_node_unsubscribe_async ()

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 .

Parameters

self

a pubsub node

 

jid

the JID subscribed to self (usually the connection's bare or full JID); may not be NULL

 

subid

the identifier associated with the subscription

 

cancellable

optional GCancellable object, NULL to ignore

 

callback

a callback to call when the request is completed

 

user_data

data to pass to callback

 

wocky_pubsub_node_unsubscribe_finish ()

gboolean
wocky_pubsub_node_unsubscribe_finish (WockyPubsubNode *self,
                                      GAsyncResult *result,
                                      GError **error);

wocky_pubsub_node_delete_async ()

void
wocky_pubsub_node_delete_async (WockyPubsubNode *self,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

wocky_pubsub_node_delete_finish ()

gboolean
wocky_pubsub_node_delete_finish (WockyPubsubNode *self,
                                 GAsyncResult *result,
                                 GError **error);

wocky_pubsub_node_list_subscribers_async ()

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!)

Parameters

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 callback .

 

wocky_pubsub_node_list_subscribers_finish ()

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.

Parameters

self

a pubsub node

 

result

the result passed to a callback

 

subscribers

location at which to store a list of WockyPubsubSubscription pointers, or NULL

 

error

location at which to store an error, or NULL

 

Returns

TRUE if the list of subscribers was successfully retrieved; FALSE and sets error if an error occured.


wocky_pubsub_affiliation_new ()

WockyPubsubAffiliation *
wocky_pubsub_affiliation_new (WockyPubsubNode *node,
                              const gchar *jid,
                              WockyPubsubAffiliationState state);

Parameters

node

a node

 

jid

the JID affiliated to node

 

state

the state of jid 's affiliation to node

 

Returns

a new structure representing an affiliation, which should ultimately be freed with wocky_pubsub_affiliation_free()


wocky_pubsub_affiliation_copy ()

WockyPubsubAffiliation *
wocky_pubsub_affiliation_copy (WockyPubsubAffiliation *aff);

Parameters

aff

an existing affiliation structure

 

Returns

a duplicate of aff ; the duplicate should ultimately be freed with wocky_pubsub_affiliation_free()


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()

Parameters

aff

an affiliation

 

wocky_pubsub_affiliation_list_copy ()

GList *
wocky_pubsub_affiliation_list_copy (GList *affs);

Shorthand for manually copying affs , duplicating each element with wocky_pubsub_affiliation_copy().

Parameters

affs

a list of WockyPubsubAffiliation

 

Returns

a deep copy of affs , which should ultimately be freed with wocky_pubsub_affiliation_list_free().


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().

Parameters

affs

a list of WockyPubsubAffiliation

 

wocky_pubsub_node_list_affiliates_async ()

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!)

Parameters

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 callback .

 

wocky_pubsub_node_list_affiliates_finish ()

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.

Parameters

self

a pubsub node

 

result

the result passed to a callback

 

affiliates

location at which to store a list of WockyPubsubAffiliation pointers, or NULL

 

error

location at which to store an error, or NULL

 

Returns

TRUE if the list of subscribers was successfully retrieved; FALSE and sets error if an error occured.


wocky_pubsub_node_modify_affiliates_async ()

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.

Parameters

self

a pubsub node

 

affiliates

a list of WockyPubsubAffiliation structures, describing only the affiliations which should be changed.

 

cancellable

optional GCancellable object, NULL to ignore

 

callback

a callback to call when the request is completed

 

user_data

data to pass to callback

 

wocky_pubsub_node_modify_affiliates_finish ()

gboolean
wocky_pubsub_node_modify_affiliates_finish
                               (WockyPubsubNode *self,
                                GAsyncResult *result,
                                GError **error);

Complete a call to wocky_pubsub_node_modify_affiliates_async().

Parameters

self

a node

 

result

the result

 

error

location at which to store an error, if one occurred.

 

Returns

TRUE if the affiliates were successfully modified; FALSE and sets error otherwise.


wocky_pubsub_node_get_configuration_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.

Parameters

self

a node

 

cancellable

optional GCancellable object, NULL to ignore

 

callback

a callback to call when the request is completed

 

user_data

data to pass to callback

 

wocky_pubsub_node_get_configuration_finish ()

WockyDataForm *
wocky_pubsub_node_get_configuration_finish
                               (WockyPubsubNode *self,
                                GAsyncResult *result,
                                GError **error);

Complete a call to wocky_pubsub_node_get_configuration_async().

Parameters

self

a node

 

result

the result

 

error

location at which to store an error, if one occurred.

 

Returns

a form representing the node configuration on success; NULL and sets error otherwise

Types and Values

struct WockyPubsubNodeClass

struct WockyPubsubNodeClass {
};

The class of a WockyPubsubNode.


enum WockyPubsubAffiliationState

Possible affiliations to a PubSub node, which determine privileges an entity has. See XEP-0060 §4.1 for the details.

Members

WOCKY_PUBSUB_AFFILIATION_OWNER

Owner

 

WOCKY_PUBSUB_AFFILIATION_PUBLISHER

Publisher

 

WOCKY_PUBSUB_AFFILIATION_PUBLISH_ONLY

Publish-Only

 

WOCKY_PUBSUB_AFFILIATION_MEMBER

Member

 

WOCKY_PUBSUB_AFFILIATION_NONE

None

 

WOCKY_PUBSUB_AFFILIATION_OUTCAST

Outcast

 

Property Details

The “name” property

  “name”                     gchar *

The name of the pubsub node.

Flags: Read / Write / Construct Only

Default value: NULL


The “service” property

  “service”                  WockyPubsubService *

the Wocky Pubsub service associated with this pubsub node.

Flags: Read / Write / Construct Only

Signal Details

The “deleted” signal

void
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.

Parameters

node

a pubsub node

 

stanza

the message/event stanza in its entirety

 

event_node

the event node from stanza

 

delete_node

the delete node from stanza

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “event-received” signal

void
user_function (WockyPubsubNode *node,
               WockyStanza     *event_stanza,
               gpointer         event_node,
               gpointer         items_node,
               gpointer         items,
               gpointer         user_data)

Parameters

node

a pubsub node

 

event_stanza

the message/event stanza in its entirity

 

event_node

the event node from the stanza

 

items_node

the items node from the stanza

 

items

a list of WockyNode *s for each item child of items_node

 

user_data

user data set when the signal handler was connected.

 

The “subscription-state-changed” signal

void
user_function (WockyPubsubNode         *node,
               WockyStanza             *stanza,
               gpointer                 event_node,
               gpointer                 subscription_node,
               WockyPubsubSubscription *subscription,
               gpointer                 user_data)

Parameters

node

a pubsub node

 

stanza

the message/event stanza in its entirety

 

event_node

the event node from stanza

 

subscription_node

the subscription node from stanza

 

subscription

subscription information parsed from subscription_node

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last