Zone class
Availability:
SmartFoxServer PRO 1.2.1
Description:
A Zone object represents one zone / application running in
the server.
Here follows a list of public methods for this object.
Public Methods:
addBuddy(who, buddyName) | Adds a buddy (buddyName) to the user (who) buddy list | |
checkBuddy(buddyName) | Checks if a buddy (buddyName) is logged in the current Zone. Returns a boolean | |
clearBuddyList(who) | who = user name of the client. Clears the user's buddy list. | |
getAutoJoinRoom() | Return the ID of the room set as autoJoin in the current Zone | |
getEmptyNames() | Return true if the "EmptyNames" options is turned on for the current Zone | |
getCountUpdate() | Return true if the "uCountUpdate" options is turned on for the current Zone | |
getMaxRooms() | Return the max number of rooms available for the current Zone | |
getMaxUsers() | Return the max number of users available for the current Zone | |
getName() | Return the name of the current Zone | |
getRoom(roomId) | Return the Room object from its ID | |
getRoomByName(roomName) | Return the Room object from its name | |
getRoomCount() | Return the current number of rooms in the Zone | |
getRooms() | Return a list of Room objects available in the Zone | |
getStatus() | Return true if the current Zone is active | |
getUserCount() | Return the current number of users in the Zone | |
getUserList() | Return a java.util.List containing all the users logged in that Zone | |
hasBuddyList() | Return true if the current Zone has the buddyList support turned on | |
removeBuddy(who, buddyName) | Removes a buddy (buddyName) from a user (who) buddy list | |
setPubMsgInternalEvent(flag) | If set to true an internal event will be fired each time a public message is received by the server. It can be useful for logging public messages. By defualt the flag is set to false |