Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``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.

Method | `__init__` | No summary
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 | `callbacks` | Callback list to be notified when response comes back
Method | `_resultEvent` | Undocumented
Instance Variable | `_xmlstream` | Undocumented

Inherited from `Element`:

Method | `__bytes__` | Retrieve the first character data node as UTF-8 bytes.
Method | `__delitem__` | Undocumented
Method | `__getattr__` | Undocumented
Method | `__getitem__` | Undocumented
Method | `__setitem__` | Undocumented
Method | `__unicode__` | Retrieve the first CData (content) node
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 | `compareAttribute` | Safely compare the value of an attribute against a provided value.
Method | `elements` | Iterate across all children of this Element that are Elements.
Method | `firstChildElement` | Undocumented
Method | `getAttribute` | Retrieve the value of attribname, if it exists
Method | `hasAttribute` | Determine if the specified attribute exists
Method | `swapAttributeValues` | Swap the values of two attribute.
Method | `toXml` | Serialize this Element and all children to a string.
Instance Variable | `attributes` | Dictionary of attributes associated with this Element.
Instance Variable | `children` | List of child Elements and content
Instance Variable | `defaultUri` | URI this Element exists within
Instance Variable | `localPrefixes` | Dictionary of namespace declarations on this element. The key is the prefix to bind the namespace uri to.
Instance Variable | `name` | Name of this Element
Instance Variable | `parent` | Reference to the parent Element, if any.
Instance Variable | `uri` | URI of this Element's name
Method | `_dqa` | Dequalify an attribute key as needed
Class Variable | `_idCounter` | Undocumented

def __init__(self, xmlstream, type='set'): (source)
overrides `twisted.words.xish.domish.Element.__init__`

Parameters
xmlstream:`xmlstream.XmlStream` | XmlStream to use for transmission of this IQ
type:`str` | IQ type identifier ('get' or 'set')

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.

Parameters
to:`str` | Jabber ID of the entity to send the request to
Returns
Callback list for this IQ. Any callbacks added to this list will be fired when the result comes back.

callbacks: `utility.CallbackList` = (source)

Callback list to be notified when response comes back

def _resultEvent(self, iq): (source)

Undocumented

_xmlstream = (source)

Undocumented