A publish-subscribe request.

The set of instance variables used depends on the type of request. If a variable is not applicable or not passed in the request, its value is None.

Instance Variable verb The type of publish-subscribe request. See _requestVerbMap. (type: str.)
Instance Variable items The items to be published, as domish.Elements. (type: list)
Instance Variable itemIdentifiers Identifiers of the items to be retrieved or retracted. (type: set)
Instance Variable maxItems Maximum number of items to retrieve. (type: int.)
Instance Variable nodeIdentifier Identifier of the node the request is about. (type: unicode)
Instance Variable nodeType The type of node that should be created, or for which the configuration is retrieved. 'leaf' or 'collection'. (type: str)
Instance Variable options Configurations options for nodes, subscriptions and publish requests. (type: data_form.Form)
Instance Variable subscriber The subscribing entity. (type: JID)
Instance Variable subscriptionIdentifier Identifier for a specific subscription. (type: unicode)
Instance Variable subscriptions Subscriptions to be modified, as a set of Subscription. (type: set)
Instance Variable affiliations Affiliations to be modified, as a dictionary of entity (JID to affiliation (unicode). (type: dict)
Method __init__ Undocumented
Method parseElement Parse the publish-subscribe verb and parameters out of a request.
Method send Send this request to its recipient.
Method _parse_node Parse the required node identifier out of the verbElement.
Method _render_node Render the required node identifier on the verbElement.
Method _parse_nodeOrEmpty Parse the node identifier out of the verbElement. May be empty.
Method _render_nodeOrEmpty Render the node identifier on the verbElement. May be empty.
Method _parse_nodeOrNone Parse the optional node identifier out of the verbElement.
Method _render_nodeOrNone Render the optional node identifier on the verbElement.
Method _parse_items Parse items out of the verbElement for publish requests.
Method _render_items Render items into the verbElement for publish requests.
Method _parse_jid Parse subscriber out of the verbElement for un-/subscribe requests.
Method _render_jid Render subscriber into the verbElement for un-/subscribe requests.
Method _parse_default Parse node type out of a request for the default node configuration.
Method _parse_configure Parse options out of a request for setting the node configuration.
Method _parse_configureOrNone Parse optional node configuration form in create request.
Method _render_configureOrNone Render optional node configuration form in create request.
Method _parse_itemIdentifiers Parse item identifiers out of items and retract requests.
Method _render_itemIdentifiers Render item identifiers into items and retract requests.
Method _parse_maxItems Parse maximum items out of an items request.
Method _render_maxItems Render maximum items into an items request.
Method _parse_subidOrNone Parse subscription identifier out of a request.
Method _render_subidOrNone Render subscription identifier into a request.
Method _parse_options Parse options form out of a subscription options request.
Method _render_options Undocumented
Method _parse_optionsWithSubscribe Undocumented
Method _render_optionsWithSubscribe Undocumented
Method _parse_affiliations Undocumented

Inherited from Stanza:

Instance Variable sender The sending entity. (type: jid.JID)
Instance Variable recipient The receiving entity. (type: jid.JID)
Class Method fromElement Create a stanza from a domish.Element.
Method toElement Undocumented
verb =
The type of publish-subscribe request. See _requestVerbMap. (type: str.)
items =
The items to be published, as domish.Elements. (type: list)
itemIdentifiers =
Identifiers of the items to be retrieved or retracted. (type: set)
maxItems =
Maximum number of items to retrieve. (type: int.)
nodeIdentifier =
Identifier of the node the request is about. (type: unicode)
nodeType =
The type of node that should be created, or for which the configuration is retrieved. 'leaf' or 'collection'. (type: str)
options =
Configurations options for nodes, subscriptions and publish requests. (type: data_form.Form)
subscriber =
The subscribing entity. (type: JID)
subscriptionIdentifier =
Identifier for a specific subscription. (type: unicode)
subscriptions =
Subscriptions to be modified, as a set of Subscription. (type: set)
affiliations =
Affiliations to be modified, as a dictionary of entity (JID to affiliation (unicode). (type: dict)
def __init__(self, verb=None): (source)
Undocumented
def _parse_node(self, verbElement): (source)

Parse the required node identifier out of the verbElement.

def _render_node(self, verbElement): (source)

Render the required node identifier on the verbElement.

def _parse_nodeOrEmpty(self, verbElement): (source)

Parse the node identifier out of the verbElement. May be empty.

def _render_nodeOrEmpty(self, verbElement): (source)

Render the node identifier on the verbElement. May be empty.

def _parse_nodeOrNone(self, verbElement): (source)

Parse the optional node identifier out of the verbElement.

def _render_nodeOrNone(self, verbElement): (source)

Render the optional node identifier on the verbElement.

def _parse_items(self, verbElement): (source)

Parse items out of the verbElement for publish requests.

def _render_items(self, verbElement): (source)

Render items into the verbElement for publish requests.

def _parse_jid(self, verbElement): (source)

Parse subscriber out of the verbElement for un-/subscribe requests.

def _render_jid(self, verbElement): (source)

Render subscriber into the verbElement for un-/subscribe requests.

def _parse_default(self, verbElement): (source)

Parse node type out of a request for the default node configuration.

def _parse_configure(self, verbElement): (source)

Parse options out of a request for setting the node configuration.

def _parse_configureOrNone(self, verbElement): (source)

Parse optional node configuration form in create request.

def _render_configureOrNone(self, verbElement): (source)

Render optional node configuration form in create request.

def _parse_itemIdentifiers(self, verbElement): (source)

Parse item identifiers out of items and retract requests.

def _render_itemIdentifiers(self, verbElement): (source)

Render item identifiers into items and retract requests.

def _parse_maxItems(self, verbElement): (source)

Parse maximum items out of an items request.

def _render_maxItems(self, verbElement): (source)

Render maximum items into an items request.

def _parse_subidOrNone(self, verbElement): (source)

Parse subscription identifier out of a request.

def _render_subidOrNone(self, verbElement): (source)

Render subscription identifier into a request.

def _parse_options(self, verbElement): (source)

Parse options form out of a subscription options request.

def _render_options(self, verbElement): (source)
Undocumented
def _parse_optionsWithSubscribe(self, verbElement): (source)
Undocumented
def _render_optionsWithSubscribe(self, verbElement): (source)
Undocumented
def _parse_affiliations(self, verbElement): (source)
Undocumented
def parseElement(self, element): (source)

Parse the publish-subscribe verb and parameters out of a request.

def send(self, xs): (source)

Send this request to its recipient.

This renders all of the relevant parameters for this specific requests into an IQ, and invoke its send method. This returns a deferred that fires upon reception of a response. See IQ for details.

ParametersxsThe XML stream to send the request on. (type: twisted.words.protocols.jabber.xmlstream.XmlStream)
Returns (type: defer.Deferred.)
API Documentation for wokkel, generated by pydoctor at 2018-12-06 14:45:46.