Package xmpp :: Module protocol :: Class Protocol
[show private | hide private]
[frames | no frames]

Class Protocol

Node --+
       |
      Protocol

Known Subclasses:
Error, Iq, Message, Presence

A "stanza" object class. Contains methods that are common for presences, iqs and messages.
Method Summary
  __init__(self, name, to, typ, frm, attrs, payload, timestamp, xmlns, node)
Constructor, name is the name of the stanza i.e.
  __setitem__(self, item, val)
Set the item 'item' to the value 'val'.
  getError(self)
Return the error-condition (if present) or the textual description of the error (otherwise).
  getErrorCode(self)
Return the error code.
  getFrom(self)
Return value of the 'from' attribute.
  getID(self)
Return the value of the 'id' attribute.
  getProperties(self)
Return the list of namespaces to which belongs the direct childs of element
  getTimestamp(self)
Return the timestamp in the 'yyyymmddThhmmss' format.
  getTo(self)
Return value of the 'to' attribute.
  getType(self)
Return the value of the 'type' attribute.
  setError(self, error, code)
Set the error code.
  setFrom(self, val)
Set the value of the 'from' attribute.
  setID(self, val)
Set the value of the 'id' attribute.
  setTimestamp(self, val)
Set the timestamp.
  setTo(self, val)
Set the value of the 'to' attribute.
  setType(self, val)
Set the value of the 'type' attribute.
    Inherited from Node
  __delitem__(self, item)
Deletes node's attribute "item".
  __getitem__(self, item)
Returns node's attribute "item" value.
  __str__(self, parent, fancy)
  addChild(self, name, attrs, payload, namespace, node)
If "node" argument is provided, adds it as child node.
  addData(self, data)
Adds some CDATA to node.
  clearData(self)
Removes all CDATA from the node.
  delAttr(self, key)
Deletes an attribute "key"
  delChild(self, node, attrs)
Deletes the "node" from the node's childs list, if "node" is an instance.
  getAttr(self, key)
Returns value of specified attribute.
  getAttrs(self)
Returns all node's attributes as dictionary.
  getChildren(self)
Returns all node's child nodes as list.
  getData(self)
Returns all node CDATA as string (concatenated).
  getName(self)
Returns the name of node
  getNamespace(self)
Returns the namespace of node
  getParent(self)
Returns the parent of node (if present).
  getPayload(self)
Return the payload of node i.e.
  getTag(self, name, attrs, namespace)
Filters all child nodes using specified arguments as filter.
  getTagAttr(self, tag, attr)
Returns attribute value of the child with specified name (or None if no such attribute).
  getTagData(self, tag)
Returns cocatenated CDATA of the child with specified name.
  getTags(self, name, attrs, namespace, one)
Filters all child nodes using specified arguments as filter.
  has_attr(self, key)
Checks if node have attribute "key".
  setAttr(self, key, val)
Sets attribute "key" with the value "val".
  setData(self, data)
Sets node's CDATA to provided string.
  setName(self, val)
Changes the node name.
  setNamespace(self, namespace)
Changes the node namespace.
  setParent(self, node)
Sets node's parent to "node".
  setPayload(self, payload, add)
Sets node payload according to the list specified.
  setTag(self, name, attrs, namespace)
Same as getTag but if the node with specified namespace/attributes not found, creates such node and returns it.
  setTagAttr(self, tag, attr, val)
Creates new node (if not already present) with name "tag" and sets it's attribute "attr" to value "val".
  setTagData(self, tag, val, attrs)
Creates new node (if not already present) with name "tag" and (optionally) attributes "attrs" and sets it's CDATA to string "val".

Class Variable Summary
    Inherited from Node
int FORCE_NODE_RECREATION = 0                                                                     

Method Details

__init__(self, name=None, to=None, typ=None, frm=None, attrs={}, payload=[], timestamp=None, xmlns='jabber:client', node=None)
(Constructor)

Constructor, name is the name of the stanza i.e. 'message' or 'presence' or 'iq'. to is the value of 'to' attribure, 'typ' - 'type' attribute frn - from attribure, attrs - other attributes mapping, payload - same meaning as for simplexml payload definition timestamp - the time value that needs to be stamped over stanza xmlns - namespace of top stanza node node - parsed or unparsed stana to be taken as prototype.
Overrides:
xmpp.simplexml.Node.__init__

__setitem__(self, item, val)
(Index assignment operator)

Set the item 'item' to the value 'val'.
Overrides:
xmpp.simplexml.Node.__setitem__

getError(self)

Return the error-condition (if present) or the textual description of the error (otherwise).

getErrorCode(self)

Return the error code. Obsolette.

getFrom(self)

Return value of the 'from' attribute.

getID(self)

Return the value of the 'id' attribute.

getProperties(self)

Return the list of namespaces to which belongs the direct childs of element

getTimestamp(self)

Return the timestamp in the 'yyyymmddThhmmss' format.

getTo(self)

Return value of the 'to' attribute.

getType(self)

Return the value of the 'type' attribute.

setError(self, error, code=None)

Set the error code. Obsolette. Use error-conditions instead.

setFrom(self, val)

Set the value of the 'from' attribute.

setID(self, val)

Set the value of the 'id' attribute.

setTimestamp(self, val=None)

Set the timestamp. timestamp should be the yyyymmddThhmmss string.

setTo(self, val)

Set the value of the 'to' attribute.

setType(self, val)

Set the value of the 'type' attribute.

Generated by Epydoc 2.1 on Sun Dec 26 09:52:57 2004 http://epydoc.sf.net