![]() |
![]() |
![]() |
Wocky Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
enum WockyPubsubServiceError; GQuark wocky_pubsub_service_error_quark (void
); #define WOCKY_PUBSUB_SERVICE_ERROR struct WockyPubsubServiceClass; WockyPubsubService * wocky_pubsub_service_new (WockySession *session
,const gchar *jid
); WockyPubsubNode * wocky_pubsub_service_ensure_node (WockyPubsubService *self
,const gchar *name
); WockyPubsubNode * wocky_pubsub_service_lookup_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
); 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
); 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
); enum WockyPubsubSubscriptionState; WockyPubsubSubscription; #define WOCKY_TYPE_PUBSUB_SUBSCRIPTION GType wocky_pubsub_subscription_get_type (void
); 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
); WockyPubsubServicePrivate;
GEnum +----WockyPubsubServiceError
GEnum +----WockyPubsubSubscriptionState
GBoxed +----WockyPubsubSubscription
typedef enum { WOCKY_PUBSUB_SERVICE_ERROR_WRONG_REPLY, } WockyPubsubServiceError;
WockyPubsubService specific errors.
struct WockyPubsubServiceClass { GObjectClass parent_class; GType node_object_type; };
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
);
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
|
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_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
);
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
);
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
);
typedef enum { WOCKY_PUBSUB_SUBSCRIPTION_NONE, WOCKY_PUBSUB_SUBSCRIPTION_PENDING, WOCKY_PUBSUB_SUBSCRIPTION_SUBSCRIBED, WOCKY_PUBSUB_SUBSCRIPTION_UNCONFIGURED } WockyPubsubSubscriptionState;
Describes the state of a subscription to a node. Definitions are taken from XEP-0060 §4.2.
The node MUST NOT send event notifications or payloads to the Entity. | |
An entity has requested to subscribe to a node and the request has not yet been approved by a node owner. The node MUST NOT send event notifications or payloads to the entity while it is in this state. | |
An entity has subscribed but its subscription options have not yet been configured. The node MAY send event notifications or payloads to the entity while it is in this state. The service MAY timeout unconfigured subscriptions. | |
An entity is subscribed to a node. The node MUST send all event notifications (and, if configured, payloads) to the entity while it is in this state (subject to subscriber configuration and content filtering). |
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
);
WockyPubsubSubscription * wocky_pubsub_subscription_copy
(WockyPubsubSubscription *sub
);
void wocky_pubsub_subscription_free (WockyPubsubSubscription *sub
);