пятница, февраля 08, 2008

Класс Zone. Server Side API. SmartFoxServer

Класс Zone представляет методы управления и доступа к данным зоны сервера SmartFoxServer.

addBuddy(who, buddyName)
Добавляет друга (buddyName) в список друзей пользователя (who) .

checkBuddy(buddyName)
Проверяет, что друг (buddyName) авторизован в текущей зоне. возвращает boolean.

clearBuddyList(who)
Очищает список друзей пользователя с именем who.

getAutoJoinRoom()
Возвращает идентификатор комнаты для автоматического входа в текущей зоне.

getEmptyNames()
Возвращает true, если в текущей зоне включена опция "EmptyNames".

getCountUpdate()
Возвращает true, если в текущей зоне влючена опция "uCountUpdate".

getMaxRooms()
Возвращает максимальное число комнат, доступное в текущей зоне.

getMaxUsers()
Возвращает максимальное число пользователей, доступное в текущей зоне.

getName()
Возвращает имя текущей зоны.

getRoom(roomId)
Возвращает объект комнаты с идентификатором roomId.

getRoomByName(roomName)
Возвращает объект комнаты с именем roomName.

getRoomCount()
Возвращает текущее количество комнат в зоне.

getRooms()
Возвращает список объектов Room всех комнат зоны.

getStatus()
Возвращает true, если зона в состоянии активности.

getUserCount()
Возвращает текущее число пользователей зоны.

getUserList()
Возвращает список java.util.List, содержащий всех пользователей, авторизованных в зоне.
java.util.List - упорядоченная коллекция или секвенция. Для использования в SmartFoxServer нам очень полезен будет метод toArray(), позволяющий преобразовать список-коллекцию в обычный массив.

hasBuddyList()
Возвращает true, если для текущей зоны включена поддержка списков друзей buddyList.

removeBuddy(who, buddyName)
Удаляет друга (buddyName) из списка друзей пользователя (who).

setPubMsgInternalEvent(flag)
Если установить в true, каждый раз, при поступлении публичного сообщения на сервер, будет генерироваться внутреннее событие. Это полезно для ведения журнала сообщений. По умоляанию false.

Комментариев нет: