A Multi User Chat Room.

An in memory object representing a MUC room from the perspective of a client.

Instance Variable roomJID The Room JID of the MUC room. (type: JID)
Instance Variable nick The nick name for the client in this room. (type: unicode)
Instance Variable occupantJID The JID of the occupant in the room. Generated from roomJID and nick. (type: JID)
Instance Variable locked Flag signalling a locked room. A locked room first needs to be configured before it can be used. See MUCClientProtocol.getConfiguration and MUCClientProtocol.configure. (type: bool)
Method __init__ Initialize the room.
Method setNick Undocumented
Method addUser Add a user to the room roster.
Method inRoster Check if a user is in the MUC room.
Method getUser Get a user from the room's roster.
Method removeUser Remove a user from the MUC room's roster.
roomJID =
The Room JID of the MUC room. (type: JID)
nick =
The nick name for the client in this room. (type: unicode)
occupantJID =
The JID of the occupant in the room. Generated from roomJID and nick. (type: JID)
locked =
Flag signalling a locked room. A locked room first needs to be configured before it can be used. See MUCClientProtocol.getConfiguration and MUCClientProtocol.configure. (type: bool)
def __init__(self, roomJID, nick): (source)

Initialize the room.

def setNick(self, nick): (source)
Undocumented
def addUser(self, user): (source)

Add a user to the room roster.

ParametersuserThe user object that is being added to the room. (type: User)
def inRoster(self, user): (source)

Check if a user is in the MUC room.

ParametersuserThe user object to check. (type: User)
def getUser(self, nick): (source)

Get a user from the room's roster.

ParametersnickThe nick for the user in the MUC room. (type: unicode)
def removeUser(self, user): (source)

Remove a user from the MUC room's roster.

ParametersuserThe user object to check. (type: User)
API Documentation for wokkel, generated by pydoctor at 2018-12-06 14:45:46.