class documentation

class twisted.words.protocols.jabber.xmlstream.IQ(domish.Element): (source)

View In Hierarchy

Wrapper for an iq stanza.

Iq stanzas are used for communications with a request-response behaviour. Each iq request is associated with an XML stream and has its own unique id to be able to track the response.

Instance Variable timeout if set, a timeout period after which the deferred returned by send will have its errback called with a TimeoutError failure.
Method __init__
Method send Send out this iq.
Instance Variable _xmlstream Undocumented

Inherited from Element:

Instance Variable uri Element's namespace URI
Instance Variable name Element's local name
Instance Variable defaultUri Default namespace URI of child elements
Instance Variable children List of child nodes
Instance Variable parent Reference to element's parent element
Instance Variable attributes Dictionary of element attributes
Instance Variable localPrefixes Dictionary of local prefixes
Method __getattr__ Undocumented
Method __getitem__ Undocumented
Method __delitem__ Undocumented
Method __setitem__ Undocumented
Method __unicode__ Retrieve the first CData (content) node
Method __bytes__ Retrieve the first character data node as UTF-8 bytes.
Method getAttribute Retrieve the value of attribname, if it exists
Method hasAttribute Determine if the specified attribute exists
Method compareAttribute Safely compare the value of an attribute against a provided value.
Method swapAttributeValues Swap the values of two attribute.
Method addChild Add a child to this Element.
Method addContent Add some text data to this Element.
Method addElement Create an element and add as child.
Method addRawXml Add a pre-serialized chunk o' XML as a child of this Element.
Method addUniqueId Add a unique (across a given Python session) id attribute to this Element.
Method elements Iterate across all children of this Element that are Elements.
Method toXml Serialize this Element and all children to a string.
Method firstChildElement Undocumented
Class Variable _idCounter Undocumented
Method _dqa Dequalify an attribute key as needed
timeout = (source)
if set, a timeout period after which the deferred returned by send will have its errback called with a TimeoutError failure.
(type: float)
def __init__(self, xmlstream, stanzaType='set'): (source)
ParametersxmlstreamXmlStream to use for transmission of this IQ (type: xmlstream.XmlStream)
stanzaTypeIQ type identifier ('get' or 'set') (type: str)
_xmlstream = (source)

Undocumented

def send(self, to=None): (source)

Send out this iq.

Returns a deferred that is fired when an iq response with the same id is received. Result responses will be passed to the deferred callback. Error responses will be transformed into a StanzaError and result in the errback of the deferred being invoked.

ReturnsUndocumented (type: defer.Deferred)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.