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`.`error`.`BaseError``

exception documentation

`class BaseError(Exception): (source)`

Known subclasses: `twisted.words.protocols.jabber.error.StanzaError`, `twisted.words.protocols.jabber.error.StreamError`

View In Hierarchy

Base class for XMPP error exceptions.

Method | `__init__` | Undocumented
Method | `__str__` | Undocumented
Method | `getElement` | Get XML representation from self.
Class Variable | `namespace` | The namespace of the `error` element generated by `getElement`.
Instance Variable | `appCondition` | Application specific condition element, supplementing the error condition in `condition`.
Instance Variable | `condition` | The error condition. The valid values are defined by subclasses of `BaseError`.
Instance Variable | `text` | Optional text message to supplement the condition or application specific condition.
Instance Variable | `textLang` | Identifier of the language used for the message in `text`. Values are as described in RFC 3066.

def __init__(self, condition, text=None, textLang=None, appCondition=None): (source)
overridden in `twisted.words.protocols.jabber.error.StanzaError`

Undocumented

def __str__(self): (source)

Undocumented

Returns
`str` | Undocumented

def getElement(self): (source)
overridden in `twisted.words.protocols.jabber.error.StanzaError`, `twisted.words.protocols.jabber.error.StreamError`

Get XML representation from self.

The method creates an `domish` representation of the error data contained in this exception.

Returns
`domish.Element` | Undocumented

namespace: `str` = (source)

The namespace of the `error` element generated by `getElement`.

appCondition: object providing `domish.IElement`. = (source)

Application specific condition element, supplementing the error condition in `condition`.

condition = (source)

The error condition. The valid values are defined by subclasses of `BaseError`.

text: `unicode` = (source)

Optional text message to supplement the condition or application specific condition.

textLang: `str` = (source)

Identifier of the language used for the message in `text`. Values are as described in RFC 3066.