Package pyxmpp :: Package jabber :: Module muccore :: Class MucUserX
[show private | hide private]
[frames | no frames]

Type MucUserX

                object --+        
                         |        
StanzaPayloadWrapperObject --+    
                             |    
                      MucXBase --+
                                 |
                                MucUserX

Known Subclasses:
MucAdminQuery

Wrapper for http://www.jabber.org/protocol/muc#user namespaced
stanza payload "x" elements and usually containing information
about a room user.

:Ivariables:
    - `xmlnode`: wrapped XML node
:Types:
    - `xmlnode`: `libxml2.xmlNode`

Method Summary
  add_item(self, item)
Add an item to `self`.
  clear(self)
Clear the content of `self.xmlnode` removing all <item/>, <status/>, etc.
  get_items(self)
Get a list of objects describing the content of `self`.
    Inherited from MucXBase
  __init__(self, xmlnode, copy, parent)
Copy MucXBase object or create a new one, possibly based on or wrapping an XML node.
  __del__(self)
  free(self)
Unlink and free the XML node owned by `self`.
  free_borrowed(self)
Detach the XML node borrowed by `self`.
  serialize(self)
Serialize `self` as XML.
  xpath_eval(self, expr)
Evaluate XPath expression in context of `self.xmlnode`.
    Inherited from StanzaPayloadWrapperObject
  as_xml(self, parent, doc)
Get the XML representation of `self`.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __repr__(x)
x.__repr__() <==> repr(x)
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
str ns = 'http://jabber.org/protocol/muc#user'
    Inherited from MucXBase
str element = 'x'

Method Details

add_item(self, item)

Add an item to `self`.

:Parameters:
    - `item`: the item to add.
:Types:
    - `item`: `MucItemBase`

clear(self)

Clear the content of `self.xmlnode` removing all <item/>, <status/>, etc.

get_items(self)

Get a list of objects describing the content of `self`.

:return: the list of objects.
:returntype: `list` of `MucItemBase` (`MucItem` and/or `MucStatus`)

Class Variable Details

ns

Type:
str
Value:
'http://jabber.org/protocol/muc#user'                                  

Generated by Epydoc 2.1 on Wed May 31 22:37:00 2006 http://epydoc.sf.net