Package spade :: Package xmppd :: Package modules :: Module muc :: Class Room
[hide private]
[frames] | no frames]

Class Room

source code

A MUC room

Instance Methods [hide private]
 
__init__(self, name, muc, subject=None, template=None, creator=None, whitelist=[], blacklist=[], password=None) source code
 
getName(self)
Get the room's true Name
source code
 
setName(self, n)
Set the room's true Name
source code
 
getRoomName(self)
Get the room's RoomName (display name)
source code
 
setRoomName(self, name)
Set the room's RoomName (display name)
source code
 
getSubject(self)
Get the room's Subject (topic)
source code
 
setSubject(self, name)
Set the room's Subject (topic)
source code
 
getRoomDesc(self)
Get the room's Description
source code
 
setRoomDesc(self, name)
Set the room's Description
source code
 
isLogging(self)
Check if message logging is enabled in the room
source code
 
setLogging(self, val)
Enable or disable message logging in the room
source code
 
getLang(self)
Get the language used in the room
source code
 
setLang(self, name)
Set the language used in the room
source code
 
isChangeSubject(self)
Check wether the subject can be changed in the room
source code
 
setChangeSubject(self, val)
Allow or disallow users to change the subject of the room
source code
 
isAllowInvites(self)
Check wether invitations are allowed in the room
source code
 
setAllowInvites(self, val)
Enable or disable invitations to the room
source code
 
getMaxUsers(self)
Gets maximum number of concurrent users in the room
source code
 
setMaxUsers(self, m)
Gets maximum number of concurrent users in the room
source code
 
getMinUsers(self)
Gets minimum number of concurrent users in the room
source code
 
setMinUsers(self, m)
Gets maximum number of concurrent users in the room
source code
 
getPresenceBroadcast(self)
Get the list of roles which receive presence stanzas broadcasted in the room
source code
 
addPresenceBroadcast(self, name)
Add a role to the list of roles which receive presence stanzas broadcasted in the room
source code
 
delPresenceBroadcast(self, name)
Remove a role from the list of roles which receive presence stanzas broadcasted in the room
source code
 
isPublicRoom(self)
Check wether the room is public
source code
 
setPublicRoom(self, val)
Stablish wether the room public or not.
source code
 
isPersistentRoom(self)
Check wether the room is persistent
source code
 
setPersistentRoom(self, val)
Set the persistency of the room.
source code
 
isModeratedRoom(self)
Check wether the room is moderated
source code
 
setModeratedRoom(self, val)
Make the room (un)moderated.
source code
 
isLockedDown(self)
Check wether the room is locked down.
source code
 
setLockedDown(self, val)
Lock or unlock down the room
source code
 
isAllowRegister(self)
Check wether the room allows the registration process
source code
 
setAllowRegister(self, val)
Enable or disable the registration process to the room
source code
 
isMembersOnly(self)
Check wether the room is members-only
source code
 
setMembersOnly(self, val)
Set or unset the room to members-only.
source code
 
isPasswordProtectedRoom(self)
Check wether entrance to the room is protected by a password
source code
 
setPasswordProtectedRoom(self, val)
Enable or disable password-protection.
source code
 
getPassword(self)
Get the password of the room
source code
 
setPassword(self, name)
Set the actual password of the room
source code
 
getWhois(self)
Get the whois permission
source code
 
setWhois(self, name)
Set the whois permission.
source code
 
getRoomAdmins(self)
Get the list of room admins
source code
 
addRoomAdmin(self, name)
Add an admin to the room
source code
 
delRoomAdmin(self, name)
Remove an admin from the room
source code
 
getRoomOwners(self)
Get the list of room owners
source code
 
addRoomOwner(self, name)
Add a room owner
source code
 
delRoomOwner(self, name)
Remove an owner from the room.
source code
 
__str__(self)
Return a string representation of the room
source code
 
fullJID(self)
Returns the room's full JID in the form of room@muc.platform
source code
 
dispatch(self, session, stanza)
Mini-dispatcher for the jabber stanzas that arrive to the room
source code
 
Message_cb(self, session, stanza)
Manages messages directed to a room
source code
 
Presence_cb(self, session, stanza)
Manages presence stanzas directed to a room
source code
 
IQ_cb(self, session, iq)
Manages IQ stanzas directed to a room
source code
 
reserveNick(self, jid, nick=None)
Reserve a nick in a the room.
source code
 
processRegistration(self, x, frm, stanza, session)
Process the registration form (to a room) of a user
source code
 
configRoom(self, x)
Configurate a room given a dataform with the desired configuration
source code
 
addParticipant(self, nick, fulljid, password=None)
Add a participant to a room
source code
 
deleteParticipant(self, fulljid)
Delete a participant from a room
source code
 
setAffiliation(self, participant, affiliation)
Set the affiliation of a participant
source code
Method Details [hide private]

setPublicRoom(self, val)

source code 

Stablish wether the room public or not. If a room is not public, then it is hidden

setPersistentRoom(self, val)

source code 

Set the persistency of the room. If the room is not persistent, then it is temporary

setModeratedRoom(self, val)

source code 

Make the room (un)moderated. All the required notifications and role changes will take effect

isLockedDown(self)

source code 

Check wether the room is locked down. A room is locked down while the owner is configuring it for the first time

setMembersOnly(self, val)

source code 

Set or unset the room to members-only. If the rooms becomes members-only, all the non-members, non-admins and non-owners participants will be miserably kicked out

setPasswordProtectedRoom(self, val)

source code 

Enable or disable password-protection. Note that this method does NOT set the password itself. To set the actual password use setPassword

setWhois(self, name)

source code 

Set the whois permission. Possible values are:
- 'anyone' : the room is non-anonymous
- 'moderators' : the room is semi-anonymous
- '' (empty) : the room is fully-anonymous

delRoomOwner(self, name)

source code 

Remove an owner from the room. Will not work if there is only one owner and tries to step down

reserveNick(self, jid, nick=None)

source code 

Reserve a nick in a the room. A jid can make a pre-reservation (nick == None). If a jid already has a correct nick reserved, it cannot be changed.