Known implementations: wokkel.pubsub.PubSubClient

No interface docstring
Method itemsReceived Called when an items notification has been received for a node.
Method deleteReceived Called when a deletion notification has been received for a node.
Method purgeReceived Called when a purge notification has been received for a node.
Method createNode Create a new publish subscribe node.
Method deleteNode Delete a node.
Method subscribe Subscribe to a node with a given JID.
Method unsubscribe Unsubscribe from a node with a given JID.
Method publish Publish to a node.
def itemsReceived(event): (source)

Called when an items notification has been received for a node.

An item can be an element named item or retract. Respectively, they signal an item being published or retracted, optionally accompanied with an item identifier in the id attribute.

ParameterseventThe items event. (type: ItemsEvent)
def deleteReceived(event): (source)

Called when a deletion notification has been received for a node.

ParameterseventThe items event. (type: ItemsEvent)
def purgeReceived(event): (source)

Called when a purge notification has been received for a node.

Upon receiving this notification all items associated should be considered retracted.

ParameterseventThe items event. (type: ItemsEvent)
def createNode(service, nodeIdentifier=None): (source)

Create a new publish subscribe node.

ParametersserviceThe publish-subscribe service entity. (type: JID)
nodeIdentifierOptional suggestion for the new node's identifier. If omitted, the creation of an instant node will be attempted. (type: unicode)
Returnsa deferred that fires with the identifier of the newly created node. Note that this can differ from the suggested identifier if the publish subscribe service chooses to modify or ignore the suggested identifier. (type: Deferred)
def deleteNode(service, nodeIdentifier): (source)

Delete a node.

ParametersserviceThe publish-subscribe service entity. (type: JID)
nodeIdentifierIdentifier of the node to be deleted. (type: unicode)
Returns (type: Deferred)
def subscribe(service, nodeIdentifier, subscriber): (source)

Subscribe to a node with a given JID.

ParametersserviceThe publish-subscribe service entity. (type: JID)
nodeIdentifierIdentifier of the node to subscribe to. (type: unicode)
subscriberJID to subscribe to the node. (type: JID)
Returns (type: Deferred)
def unsubscribe(service, nodeIdentifier, subscriber): (source)

Unsubscribe from a node with a given JID.

ParametersserviceThe publish-subscribe service entity. (type: JID)
nodeIdentifierIdentifier of the node to unsubscribe from. (type: unicode)
subscriberJID to unsubscribe from the node. (type: JID)
Returns (type: Deferred)
def publish(service, nodeIdentifier, items=[]): (source)

Publish to a node.

Node that the items parameter is optional, because so-called transient, notification-only nodes do not use items and publish actions only signify a change in some resource.

ParametersserviceThe publish-subscribe service entity. (type: JID)
nodeIdentifierIdentifier of the node to publish to. (type: unicode)
itemsList of item elements. (type: list of Item)
Returns (type: Deferred)
API Documentation for wokkel, generated by pydoctor at 2018-12-06 14:45:46.