![]() |
![]() |
![]() |
wocky Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
WockyPubsubService; WockyPubsubServiceClass; WockyPubsubService * wocky_pubsub_service_new (WockySession *session
,const gchar *jid
); void wocky_pubsub_service_create_node_async (WockyPubsubService *self
,const gchar *name
,WockyDataForm *config
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); WockyPubsubNode * wocky_pubsub_service_create_node_finish (WockyPubsubService *self
,GAsyncResult *result
,GError **error
); WockyPubsubNode * wocky_pubsub_service_ensure_node (WockyPubsubService *self
,const gchar *name
); void wocky_pubsub_service_get_default_node_configuration_async (WockyPubsubService *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); WockyDataForm * wocky_pubsub_service_get_default_node_configuration_finish (WockyPubsubService *self
,GAsyncResult *result
,GError **error
); WockyPubsubNode * wocky_pubsub_service_lookup_node (WockyPubsubService *self
,const gchar *name
); void wocky_pubsub_service_retrieve_subscriptions_async (WockyPubsubService *self
,WockyPubsubNode *node
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean wocky_pubsub_service_retrieve_subscriptions_finish (WockyPubsubService *self
,GAsyncResult *result
,GList **subscriptions
,GError **error
); #define WOCKY_TYPE_PUBSUB_SUBSCRIPTION WockyPubsubSubscription; WockyPubsubSubscription * wocky_pubsub_subscription_new (WockyPubsubNode *node
,const gchar *jid
,WockyPubsubSubscriptionState state
,const gchar *subid
); WockyPubsubSubscription * wocky_pubsub_subscription_copy (WockyPubsubSubscription *sub
); void wocky_pubsub_subscription_free (WockyPubsubSubscription *sub
); GList * wocky_pubsub_subscription_list_copy (GList *subs
); void wocky_pubsub_subscription_list_free (GList *subs
); #define WOCKY_TYPE_PUBSUB_SUBSCRIPTION_STATE enum WockyPubsubSubscriptionState; #define WOCKY_TYPE_PUBSUB_SERVICE_ERROR #define WOCKY_PUBSUB_SERVICE_ERROR enum WockyPubsubServiceError;
"jid" gchar* : Read / Write / Construct Only "session" WockySession* : Read / Write / Construct Only
typedef struct { GObjectClass parent_class; GType node_object_type; } WockyPubsubServiceClass;
The class structure for the WockyPubsubService type.
GObjectClass |
parent |
GType |
the subtype of WOCKY_TYPE_PUBSUB_NODE to be created by
wocky_pubsub_service_ensure_node()
|
WockyPubsubService * wocky_pubsub_service_new (WockySession *session
,const gchar *jid
);
|
|
|
|
Returns : |
void wocky_pubsub_service_create_node_async (WockyPubsubService *self
,const gchar *name
,WockyDataForm *config
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
|
|
|
|
|
|
|
|
|
|
|
WockyPubsubNode * wocky_pubsub_service_create_node_finish (WockyPubsubService *self
,GAsyncResult *result
,GError **error
);
|
|
|
|
|
|
Returns : |
WockyPubsubNode * wocky_pubsub_service_ensure_node (WockyPubsubService *self
,const gchar *name
);
Fetches or creates an object representing a node on the pubsub service. Note that this does not ensure that a node exists on the server; it merely ensures a local representation.
|
a pubsub service |
|
the name of a node on self
|
Returns : |
a new reference to an object representing a node named name on
self
|
void wocky_pubsub_service_get_default_node_configuration_async (WockyPubsubService *self
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
|
|
|
|
|
|
|
WockyDataForm * wocky_pubsub_service_get_default_node_configuration_finish (WockyPubsubService *self
,GAsyncResult *result
,GError **error
);
|
|
|
|
|
|
Returns : |
WockyPubsubNode * wocky_pubsub_service_lookup_node (WockyPubsubService *self
,const gchar *name
);
Fetches an object representing a node on a pubsub service, if the object
already exists; if not, returns NULL
. Note that this does not check whether
a node exists on the server; it only checks for a local representation.
|
a pubsub service |
|
the name of a node on self
|
Returns : |
a borrowed reference to a node, or NULL
|
void wocky_pubsub_service_retrieve_subscriptions_async (WockyPubsubService *self
,WockyPubsubNode *node
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
|
|
|
|
|
|
|
|
|
gboolean wocky_pubsub_service_retrieve_subscriptions_finish (WockyPubsubService *self
,GAsyncResult *result
,GList **subscriptions
,GError **error
);
|
|
|
|
|
|
|
|
Returns : |
typedef struct { WockyPubsubNode *node; gchar *jid; WockyPubsubSubscriptionState state; gchar *subid; } WockyPubsubSubscription;
Represents a subscription to a node on a pubsub service, as seen when
listing your own subscriptions on a service with
wocky_pubsub_service_retrieve_subscriptions_async()
or subscribing to a node
with wocky_pubsub_node_subscribe_async()
.
WockyPubsubNode * |
a PubSub node |
gchar * |
the JID which is subscribed to node . This may be a bare JID, or a
full JID with a resource, depending on which was specified when
subscribing to node . See XEP-0060 §6.1 Subscribe to a Node
|
WockyPubsubSubscriptionState |
the state of this subscription |
gchar * |
a unique identifier for this subscription, if a JID is subscribed to
a node multiple times, or NULL if there is no such identifier. See
XEP-0060 §6.1.6 “Multiple Subscriptions”
|
WockyPubsubSubscription * wocky_pubsub_subscription_new (WockyPubsubNode *node
,const gchar *jid
,WockyPubsubSubscriptionState state
,const gchar *subid
);
|
|
|
|
|
|
|
|
Returns : |
WockyPubsubSubscription * wocky_pubsub_subscription_copy
(WockyPubsubSubscription *sub
);
|
|
Returns : |
void wocky_pubsub_subscription_free (WockyPubsubSubscription *sub
);
|
GList * wocky_pubsub_subscription_list_copy (GList *subs
);
|
|
Returns : |
void wocky_pubsub_subscription_list_free (GList *subs
);
|
#define WOCKY_TYPE_PUBSUB_SUBSCRIPTION_STATE (wocky_pubsub_subscription_state_get_type())
typedef enum { WOCKY_PUBSUB_SUBSCRIPTION_NONE, WOCKY_PUBSUB_SUBSCRIPTION_PENDING, WOCKY_PUBSUB_SUBSCRIPTION_SUBSCRIBED, WOCKY_PUBSUB_SUBSCRIPTION_UNCONFIGURED } WockyPubsubSubscriptionState;
#define WOCKY_TYPE_PUBSUB_SERVICE_ERROR (wocky_pubsub_service_error_get_type())
"jid"
property"jid" gchar* : Read / Write / Construct Only
The jid of the pubsub service.
Default value: NULL
"session"
property"session" WockySession* : Read / Write / Construct Only
the Wocky Session associated with this pubsub service.
"event-received"
signalvoid user_function (WockyPubsubService *service, WockyPubsubNode *node, WockyXmppStanza *event_stanza, gpointer event_node, gpointer items_node, gpointer items, gpointer user_data)
Emitted when an event is received for a node.
|
a pubsub service |
|
the node on service for which an event has been received
wire
|
|
the message/event stanza in its entirity |
|
the event node from the stanza |
|
the items node from the stanza |
|
a list of WockyXmppNode *s for each item child of items_node
|
|
user data set when the signal handler was connected. |
"node-deleted"
signalvoid user_function (WockyPubsubService *node, WockyPubsubNode *stanza, WockyXmppStanza *event_node, gpointer delete_node, gpointer arg4, gpointer user_data) : Run Last
Emitted when a notification of a node's deletion is received from the server.
|
a pubsub node |
|
the message/event stanza in its entirety |
|
the event node from stanza
|
|
the delete node from stanza
|
|
user data set when the signal handler was connected. |
"subscription-state-changed"
signalvoid user_function (WockyPubsubService *service, WockyPubsubNode *node, WockyXmppStanza *stanza, gpointer event_node, gpointer subscription_node, WockyPubsubSubscription *subscription, gpointer user_data) : Run Last
|
a pubsub service |
|
a pubsub node for which the subscription state has changed |
|
the message/event stanza in its entirety |
|
the event node from stanza
|
|
the subscription node from stanza
|
|
subscription information parsed from subscription_node
|
|
user data set when the signal handler was connected. |