EsRoom Class Reference

This class represents a room on the server. More...

Inheritance diagram for EsRoom:

Instance Methods
(EsRoomVariable *)	- roomVariableByName:
	Gets a RoomVariable object by name. More...
(NSArray *)	- users
	Gets the list of Users in this room. More...
(NSArray *)	- roomVariables
	Gets the list of RoomVariable objects. More...

Properties
int	roomId
	The id of the room. More...
NSString *	name
	The name of the room. More...
int	zoneId
	The id of the zone this room belongs to. More...
BOOL	hasPassword
	True if the room is password protected. More...
NSString *	roomDescription
	The room description. More...
int	capacity
	Allowable capacitory for the room. More...
BOOL	isHidden
	True if the room is hidden. More...
NSString *	password
	The password for this room, if any. More...
BOOL	isJoined
	True if you belong to this room. More...
int	userCount
	Number of users in this room. More...

Detailed Description

This class represents a room on the server.

It stores a list of users in the room, room variables, and many other room properties.

Method Documentation

- (EsRoomVariable *) roomVariableByName:

(NSString*)

name

Gets a RoomVariable object by name.

Parameters

Name	of the variable to find.

Returns

RoomVariable object that has the name passed in.

- (NSArray *) roomVariables

Gets the list of RoomVariable objects.

- (NSArray *) users

Gets the list of Users in this room.

Property Documentation

- (int) capacity

readatomicassign

Allowable capacitory for the room.

- (BOOL) hasPassword

readatomicassign

True if the room is password protected.

- (BOOL) isHidden

readatomicassign

True if the room is hidden.

- (BOOL) isJoined

readatomicassign

True if you belong to this room.

- (NSString*) name

readatomicretain

The name of the room.

- (NSString*) password

readatomicretain

The password for this room, if any.

- (NSString*) roomDescription

readatomicretain

The room description.

- (int) roomId

readatomicassign

The id of the room.

- (int) userCount

readatomicassign

Number of users in this room.

- (int) zoneId

readatomicassign

The id of the zone this room belongs to.