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

Class Iq

Node --+    
       |    
Protocol --+
           |
          Iq


XMPP Iq object - get/set dialog mechanism.
Method Summary
  __init__(self, typ, queryNS, attrs, to, frm, payload, xmlns, node)
Create Iq object.
  buildReply(self, typ)
Builds and returns another Iq object of specified type.
  getQueryChildren(self)
Return the 'query' child element child nodes.
  getQuerynode(self)
Return the 'node' attribute value of the 'query' child element.
  getQueryNS(self)
Return the namespace of the 'query' child element.
  getQueryPayload(self)
Return the 'query' child element payload.
  setQuerynode(self, node)
Set the 'node' attribute value of the 'query' child element.
  setQueryNS(self, namespace)
Set the namespace of the 'query' child element.
  setQueryPayload(self, payload)
Set the 'query' child element payload.
    Inherited from Protocol
  __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, typ=None, queryNS=None, attrs={}, to=None, frm=None, payload=[], xmlns='jabber:client', node=None)
(Constructor)

Create Iq object. You can specify type, query namespace any additional attributes, recipient of the iq, sender of the iq, any additional payload (f.e. jabber:x:data node) and namespace in one go. Alternatively you can pass in the other XML object as the 'node' parameted to replicate it as an iq.
Overrides:
xmpp.protocol.Protocol.__init__

buildReply(self, typ)

Builds and returns another Iq object of specified type. The to, from and query child node of new Iq are pre-set as reply to this Iq.

getQueryChildren(self)

Return the 'query' child element child nodes.

getQuerynode(self)

Return the 'node' attribute value of the 'query' child element.

getQueryNS(self)

Return the namespace of the 'query' child element.

getQueryPayload(self)

Return the 'query' child element payload.

setQuerynode(self, node)

Set the 'node' attribute value of the 'query' child element.

setQueryNS(self, namespace)

Set the namespace of the 'query' child element.

setQueryPayload(self, payload)

Set the 'query' child element payload.

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