pyxmpp.jabber.muc.MucRoomUser

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.

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

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

Method Details

### __init__(self, presence_or_user_or_jid) (Constructor) Initialize a `MucRoomUser` object. When `presence_or_user_or_jid` is a JID user's role and affiliation are set to "none". 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. (type=`MucPresence` or `MucRoomUser` or `JID`)

### 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. (type=`MucRoomUser`) Returns: `True` if the two object describe the same user. (type=`bool`)

### update_presence(self, presence) Update user information. Parameters: `presence` - a presence stanza with user information update. (type=`MucPresence`)

Instance Variable Details

### affiliation user's affiliation. Type: `str`

### nick user's nick (resource part of `room_jid`) Type: `unicode`

### presence last presence stanza received for the user. Type: `MucPresence`

### real_jid user's real jid or None if not available. Type: `JID`

### role user's role. Type: `str`

### room_jid user's room jid. Type: `JID`