Class Stanza

Parameters:

• element (unicode or ElementTree.Element) - XML element of this stanza, or element name for a new stanza. If element is given it must not be modified later, unless decode_payload() and mark_dirty() methods are called first (the element changes won't affec the stanza then).
• from_jid (JID) - sender JID.
• to_jid (JID) - recipient JID.
• stanza_type (unicode) - staza type: one of: "get", "set", "result" or "error".
• stanza_id (unicode) - stanza id -- value of stanza's "id" attribute. If not given, then unique for the session value is generated.
• error (pyxmpp.error.StanzaErrorElement) - error object. Ignored if stanza_type is not "error".
• error_cond (unicode) - error condition name. Ignored if stanza_type is not "error" or error is not None.
• return_path (StanzaRoute) - route for sending responses to this stanza. Will be weakly referenced.
• language (unicode) - default language for the stanza content

Overrides: object.__init__

Returns: unicode

serialized stanza.

Return the XML stanza representation.

Always return an independent copy of the stanza XML representation, which can be freely modified without affecting the stanza.

Returns: ElementTree.Element

Return the XML stanza representation.

This returns the original or cached XML representation, which may be much more efficient than as_xml.

Result of this function should never be modified.

Returns: ElementTree.Element

Decode payload from the element passed to the stanza constructor.

Iterates over stanza children and creates StanzaPayload objects for them. Called automatically by get_payload() and other methods that access the payload.

For the Stanza class stanza namespace child elements will also be included as the payload. For subclasses these are no considered payload.

Mark the stanza 'dirty' so the XML representation will be re-built the next time it is requested.

This should be called each time the payload attached to the stanza is modifed.

Set stanza payload to a single item.

All current stanza content of will be dropped. Marks the stanza dirty.

Parameters:

• payload (ElementTree.Element or StanzaPayload) - XML element or stanza payload object to use

Add new the stanza payload.

Marks the stanza dirty.

Parameters:

• payload (ElementTree.Element or StanzaPayload) - XML element or stanza payload object to add

Parameters:

• specialize - If True, then return objects of specialized StanzaPayload classes whenever possible, otherwise the representation already available will be used (often XMLPayload)

Returns: list of StanzaPayload

Get the first payload item matching the given class and optional key.

Payloads may be addressed using a specific payload class or via the generic XMLPayload element, though the XMLPayload representation is available only as long as the element is not requested by a more specific type.

Parameters:

• payload_class (StanzaPayload) - requested payload class, a subclass of StanzaPayload. If None get the first payload in whatever class is available.
• payload_key - optional key for additional match. When used with payload_class = XMLPayload this selects the element to match
• specialize (bool) - If True, and payload_class is None then return object of a specialized StanzaPayload subclass whenever possible

Returns: StanzaPayload

payload element found or None

Returns:

the new id.

from_jid

Get Method:

unreachable.from_jid(self) - Source JID of the stanza.

Set Method:

unreachable.from_jid(self, from_jid)

Type:

JID

to_jid

Get Method:

unreachable.to_jid(self) - Destination JID of the stanza.

Set Method:

unreachable.to_jid(self, to_jid)

Type:

JID

stanza_type

Get Method:

unreachable.stanza_type(self) - Stanza type, one of: "get", "set", "result" or "error".

Set Method:

unreachable.stanza_type(self, stanza_type)

Type:

unicode

stanza_id

Get Method:

unreachable.stanza_id(self) - Stanza id.

Set Method:

unreachable.stanza_id(self, stanza_id)

Type:

unicode

error

Get Method:

unreachable.error(self) - Stanza error element.

Set Method:

unreachable.error(self, error)

Type:

StanzaErrorElement

return_path

Get Method:

unreachable.return_path(self) - Stream the stanza was received from.

Type:

StanzaRoute