pyxmpp.message.Message

Package pyxmpp :: Module message :: Class Message |
[show private | hide private]
[frames | no frames]

## Class Message

    Stanza --+
             |
            Message

Wraper object for <message /> stanzas.

Method Summary
| ``__init__`(self, xmlnode, from_jid, to_jid, stanza_type, stanza_id, subject, body, thread, error, error_cond)` Initialize a `Message` object.
`Message` | ``copy`(self)` Create a deep copy of the message stanza.
`unicode` | ``get_body`(self)` Get the body of the message.
`unicode` | ``get_subject`(self)` Get the message subject.
`unicode` | ``get_thread`(self)` Get the thread-id subject.
`unicode` | ``make_error_response`(self, cond)` Create error response for any non-error message stanza.
Inherited from Stanza
| ``__del__`(self)`
| ``__eq__`(self, other)`
| ``__ne__`(self, other)`
| ``add_content`(self, content)` Add an XML node to the stanza's payload.
| ``add_new_content`(self, ns_uri, name)` Add a new XML element to the stanza payload.
| ``free`(self)` Free the node associated with this `Stanza` object.
`pyxmpp.error.StanzaErrorNode` | ``get_error`(self)` Get stanza error information.
`unicode` | ``get_from`(self)` Get "from" attribute of the stanza.
`unicode` | ``get_from_jid`(self)` Get "from" attribute of the stanza.
`unicode` | ``get_id`(self)` Get "id" attribute of the stanza.
`libxml2.xmlNode` | ``get_node`(self)` Return the XML node wrapped into `self`.
`unicode` | ``get_stanza_id`(self)` Get "id" attribute of the stanza.
`unicode` | ``get_stanza_type`(self)` Get "type" attribute of the stanza.
`unicode` | ``get_to`(self)` Get "to" attribute of the stanza.
`unicode` | ``get_to_jid`(self)` Get "to" attribute of the stanza.
`unicode` | ``get_type`(self)` Get "type" attribute of the stanza.
`str` | ``serialize`(self)` Serialize the stanza into an UTF-8 encoded XML string.
| ``set_content`(self, content)` Set stanza content to an XML node.
| ``set_from`(self, from_jid)` Set "from" attribute of the stanza.
| ``set_id`(self, stanza_id)` Set "id" attribute of the stanza.
| ``set_new_content`(self, ns_uri, name)` Set stanza payload to a new XML element.
| ``set_to`(self, to_jid)` Set "to" attribute of the stanza.
| ``set_type`(self, stanza_type)` Set "type" attribute of the stanza.
| ``xpath_eval`(self, expr, namespaces)` Evaluate an XPath expression on the stanza XML node.

Instance Variable Summary
Inherited from Stanza
`libxml2.xmlNode` | `xmlnode`: stanza XML node.
`pyxmpp.error.StanzaErrorNode` | `_error`: `pyxmpp.error.StanzaErrorNode` describing the error associated with the stanza of type "error".

Class Variable Summary
`str` | `stanza_type` = `'message'`

Method Details

### __init__(self, xmlnode=None, from_jid=None, to_jid=None, stanza_type=None, stanza_id=None, subject=None, body=None, thread=None, error=None, error_cond=None) (Constructor) Initialize a `Message` object. Parameters: `xmlnode` - XML node to_jid be wrapped into the `Message` object or other Message object to be copied. If not given then new presence stanza is created using following parameters. (type=`unicode` or `libxml2.xmlNode` or `Stanza`) `from_jid` - sender JID. (type=`JID`) `to_jid` - recipient JID. (type=`JID`) `stanza_type` - staza type: one of: "get", "set", "result" or "error". (type=`unicode`) `stanza_id` - stanza id -- value of stanza's "id" attribute. If not given, then unique for the session value is generated. (type=`unicode`) `subject` - message subject, (type=`unicode`) `body` - message body. (type=`unicode`) `thread` - message thread id. (type=`unicode`) `error_cond` - error condition name. Ignored if `stanza_type` is not "error". (type=`unicode`) Overrides: `pyxmpp.stanza.Stanza.__init__`

### copy(self) Create a deep copy of the message stanza. Returns: `Message` Overrides: `pyxmpp.stanza.Stanza.copy`

### get_body(self) Get the body of the message. Returns: the body of the message or `None` if there is no body. (type=`unicode`)

### get_subject(self) Get the message subject. Returns: the message subject or `None` if there is no subject. (type=`unicode`)

### get_thread(self) Get the thread-id subject. Returns: the thread-id or `None` if there is no thread-id. (type=`unicode`)

### make_error_response(self, cond) Create error response for any non-error message stanza. Parameters: `cond` - error condition name, as defined in XMPP specification. Returns: new message stanza with the same "id" as self, "from" and "to" attributes swapped, type="error" and containing <error /> element plus payload of `self`. (type=`unicode`)

Class Variable Details

    ### stanza_type Type: `str` Value:
        'message'