Home       Trees       Index       Help   

PyXMPP

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

Type MucItem

 object --+    
          |    
MucItemBase --+
              |
             MucItem


MUC <item/> element -- describes a room occupant.

:Ivariables:
    - `affiliation`: affiliation of the user.
    - `role`: role of the user.
    - `jid`: JID of the user.
    - `nick`: nickname of the user.
    - `actor`: actor modyfying the user data.
    - `reason`: reason of change of the user data.
:Types:
    - `affiliation`: `str`
    - `role`: `str`
    - `jid`: `JID`
    - `nick`: `unicode`
    - `actor`: `JID`
    - `reason`: `unicode`
Method Summary
  __init__(self, xmlnode_or_affiliation, role, jid, nick, actor, reason)
Initialize a `MucItem` object.
  as_xml(self, parent)
Create XML representation of `self`.
  __from_xmlnode(self, xmlnode)
Initialize a `MucItem` object from an XML node.
  __init(self, affiliation, role, jid, nick, actor, reason)
Initialize a `MucItem` object from a set of attributes.
    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)

Method Details

__init__(self, xmlnode_or_affiliation, role=None, jid=None, nick=None, actor=None, reason=None)
(Constructor) 

Initialize a `MucItem` object.

:Parameters:
    - `xmlnode_or_affiliation`: XML node to be pased or the affiliation of
      the user being described.
    - `role`: role of the user.
    - `jid`: JID of the user.
    - `nick`: nickname of the user.
    - `actor`: actor modyfying the user data.
    - `reason`: reason of change of the user data.
:Types:
    - `xmlnode_or_affiliation`: `libxml2.xmlNode` or `str`
    - `role`: `str`
    - `jid`: `JID`
    - `nick`: `unicode`
    - `actor`: `JID`
    - `reason`: `unicode`
Overrides:
pyxmpp.jabber.muccore.MucItemBase.__init__

as_xml(self, parent) 

Create XML representation of `self`.

:Parameters:
    - `parent`: the element to which the created node should be linked to.
:Types:
    - `parent`: `libxml2.xmlNode`

:return: an XML node.
:returntype: `libxml2.xmlNode`

__from_xmlnode(self, xmlnode) 

Initialize a `MucItem` object from an XML node.

:Parameters:
    - `xmlnode`: the XML node.
:Types:
    - `xmlnode`: `libxml2.xmlNode`

__init(self, affiliation, role, jid=None, nick=None, actor=None, reason=None) 

Initialize a `MucItem` object from a set of attributes.

:Parameters:
    - `affiliation`: affiliation of the user.
    - `role`: role of the user.
    - `jid`: JID of the user.
    - `nick`: nickname of the user.
    - `actor`: actor modyfying the user data.
    - `reason`: reason of change of the user data.
:Types:
    - `affiliation`: `str`
    - `role`: `str`
    - `jid`: `JID`
    - `nick`: `unicode`
    - `actor`: `JID`
    - `reason`: `unicode`

   Home       Trees       Index       Help   

PyXMPP

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