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.
Method Summary
  __init__(self, xmlnode_or_affiliation, role, jid, nick, actor, reason)
Initialize a MucItem object.
libxml2.xmlNode 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)

Instance Variable Summary
JID actor: actor modyfying the user data.
str affiliation: affiliation of the user.
JID jid: JID of the user.
unicode nick: nickname of the user.
unicode reason: reason of change of the user data.
str role: role of the user.

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.
           (type=libxml2.xmlNode or str)
role - role of the user.
           (type=str)
jid - JID of the user.
           (type=JID)
nick - nickname of the user.
           (type=unicode)
actor - actor modyfying the user data.
           (type=JID)
reason - reason of change of the user data.
           (type=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.
           (type=libxml2.xmlNode)
Returns:
an XML node.
           (type=libxml2.xmlNode)

__from_xmlnode(self, xmlnode)

Initialize a MucItem object from an XML node.
Parameters:
xmlnode - the XML node.
           (type=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.
           (type=str)
role - role of the user.
           (type=str)
jid - JID of the user.
           (type=JID)
nick - nickname of the user.
           (type=unicode)
actor - actor modyfying the user data.
           (type=JID)
reason - reason of change of the user data.
           (type=unicode)

Instance Variable Details

actor

actor modyfying the user data.
Type:
JID

affiliation

affiliation of the user.
Type:
str

jid

JID of the user.
Type:
JID

nick

nickname of the user.
Type:
unicode

reason

reason of change of the user data.
Type:
unicode

role

role of the user.
Type:
str