t.w.p.j.e.StanzaError(BaseError) : class documentation

Part of twisted.words.protocols.jabber.error View Source View In Hierarchy

Stanza Error exception.

Refer to RFC 3920, section 9.3, for the allowed values for condition and type.

Instance Variable type The stanza error type. Gives a suggestion to the recipient of the error on how to proceed. (type: str)
Instance Variable code A numeric identifier for the error condition for backwards compatibility with pre-XMPP Jabber implementations.
Method __init__ Undocumented
Method getElement Get XML representation from self.
Method toResponse Construct error response stanza.

Inherited from BaseError:

Class Variable namespace The namespace of the error element generated by getElement. (type: str)
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. (type: unicode)
Instance Variable textLang Identifier of the language used for the message in text. Values are as described in RFC 3066. (type: str)
Instance Variable appCondition Application specific condition element, supplementing the error condition in condition. (type: object providing domish.IElement.)
Method __str__ Undocumented
type =
The stanza error type. Gives a suggestion to the recipient of the error on how to proceed. (type: str)
code =
A numeric identifier for the error condition for backwards compatibility with pre-XMPP Jabber implementations.
def __init__(self, condition, type=None, text=None, textLang=None, appCondition=None): (source)
Undocumented
def getElement(self): (source)
Get XML representation from self.

Overrides the base BaseError.getElement to make sure the returned element has a type attribute and optionally a legacy code attribute.

Returns (type: domish.Element)
def toResponse(self, stanza): (source)
Construct error response stanza.

The stanza is transformed into an error response stanza by swapping the to and from addresses and inserting an error element.

Parametersstanzathe stanza to respond to (type: domish.Element)
NoteThis creates a shallow copy of the list of child elements of the stanza. The child elements themselves are not copied themselves, and references to their parent element will still point to the original stanza element.

The serialization of an element does not use the reference to its parent, so the typical use case of immediately sending out the constructed error response is not affected.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.