twisted.words.protocols.jabber.client.IQ(domish.Element) class documentationtwisted.words.protocols.jabber.client
View 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.
| Class Variable | callbacks | Callback list to be notified when response comes back (type: utility.CallbackList) |
| 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. |
| Method | _resultEvent | Undocumented |
Inherited from Element:
| Instance Variable | uri | URI of this Element's name (type: unicode or None) |
| Instance Variable | name | Name of this Element (type: unicode) |
| Instance Variable | defaultUri | URI this Element exists within (type: unicode or None) |
| Instance Variable | children | List of child Elements and content (type: list) |
| Instance Variable | parent | Reference to the parent Element, if any. (type: Element) |
| Instance Variable | attributes | Dictionary of attributes associated with this Element. (type: dict) |
| Instance Variable | localPrefixes | Dictionary of namespace declarations on this element. The key is the prefix
to bind the namespace uri to. (type: dict) |
| 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 |
| Method | _dqa | Dequalify an attribute key as needed |
| Parameters | xmlstream | XmlStream to use for transmission of this IQ (type: xmlstream.XmlStream) |
| type | IQ type identifier ('get' or 'set') (type: str) |
Register a callback for notification when the IQ result is available.
Call this method to send this IQ request via the associated XmlStream.
| Parameters | to | Jabber ID of the entity to send the request to (type: str) |
| Returns | Callback list for this IQ. Any callbacks added to this list will be fired when the result comes back. | |