Package pyxmpp :: Package jabber :: Module muc :: Class MucRoomUser
[show private | hide private]
[frames | no frames]

Class MucRoomUser


Describes a user of a MUC room.

The attributes of this object should not be changed directly.

:Ivariables:
    - `presence`: last presence stanza received for the user.
    - `role`: user's role.
    - `affiliation`: user's affiliation.
    - `room_jid`: user's room jid.
    - `real_jid`: user's real jid or None if not available.
    - `nick`: user's nick (resource part of `room_jid`)
:Types:
    - `presence`: `MucPresence`
    - `role`: `str`
    - `affiliation`: `str`
    - `room_jid`: `JID`
    - `real_jid`: `JID`
    - `nick`: `unicode`

Method Summary
  __init__(self, presence_or_user_or_jid)
Initialize a `MucRoomUser` object.
  same_as(self, other)
Check if two `MucRoomUser` objects describe the same user in the same room.
  update_presence(self, presence)
Update user information.

Method Details

__init__(self, presence_or_user_or_jid)
(Constructor)

Initialize a `MucRoomUser` object.

:Parameters:
    - `presence_or_user_or_jid`: a MUC presence stanza with user
      information, a user object to copy or a room JID of a user.
:Types:
    - `presence_or_user_or_jid`: `MucPresence` or `MucRoomUser` or
      `JID`

When `presence_or_user_or_jid` is a JID user's
role and affiliation are set to "none".

same_as(self, other)

Check if two `MucRoomUser` objects describe the same user in the
same room.

:Parameters:
    - `other`: the user object to compare `self` with.
:Types:
    - `other`: `MucRoomUser`

:return: `True` if the two object describe the same user.
:returntype: `bool`

update_presence(self, presence)

Update user information.

:Parameters:
    - `presence`: a presence stanza with user information update.
:Types:
    - `presence`: `MucPresence`

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