twisted.words.protocols.jabber.client.IQ

class documentation

class IQ(domish.Element): (source)

View In Hierarchy

Wrapper for a Info/Query packet.

This provides the necessary functionality to send IQs and get notified when a result comes back. It's a subclass from domish.Element, so you can use the standard DOM manipulation calls to add data to the outbound request.

Instance Variable callbacks Callback list to be notified when response comes back
Method __init__
Method addCallback Register a callback for notification when the IQ result is available.
Method send Call this method to send this IQ request via the associated XmlStream.
Instance Variable _xmlstream Undocumented
Method _resultEvent Undocumented

Inherited from Element:

Instance Variable uri URI of this Element's name
Instance Variable name Name of this Element
Instance Variable defaultUri URI this Element exists within
Instance Variable children List of child Elements and content
Instance Variable parent Reference to the parent Element, if any.
Instance Variable attributes Dictionary of attributes associated with this Element.
Instance Variable localPrefixes Dictionary of namespace declarations on this element. The key is the prefix to bind the namespace uri to.
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
callbacks = (source)
Callback list to be notified when response comes back
(type: utility.CallbackList)
def __init__(self, xmlstream, type='set'): (source)
overrides twisted.words.xish.domish.Element.__init__
ParametersxmlstreamXmlStream to use for transmission of this IQ (type: xmlstream.XmlStream)
typeIQ type identifier ('get' or 'set') (type: str)
_xmlstream = (source)

Undocumented

def addCallback(self, fn, *args, **kwargs): (source)

Register a callback for notification when the IQ result is available.

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

Call this method to send this IQ request via the associated XmlStream.

ParameterstoJabber ID of the entity to send the request to (type: str)
ReturnsCallback list for this IQ. Any callbacks added to this list will be fired when the result comes back.
def _resultEvent(self, iq): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.