EsUserEvictedFromRoomEvent Class Reference

By default, the first client joined to a room is the room operator. More...

Inheritance diagram for EsUserEvictedFromRoomEvent:

Instance Methods
(id)	- init
(id)	- initWithThriftObject:
(void)	- fromThrift:
(ThriftUserEvictedFromRoomEvent *)	- toThrift
(id)	- newThrift

Properties
int32_t	zoneId
	Id of the zone that contains the room that contains the user that was evicted. More...
int32_t	roomId
	Id of the room that contains the user that was evicted. More...
NSString *	userName
NSString *	reason
	Reason for being evicted, sent by the user who did the evicting. More...
BOOL	ban
	If true, then you are also banned from the server for an amount of time indicated by the duration property. More...
int32_t	duration
	The amount of time you are banned. More...

Additional Inherited Members
Protected Attributes inherited from EsMessage
int	messageType_

Detailed Description

By default, the first client joined to a room is the room operator.

When the client leaves the room the operator status goes to the next person that has joined the room. As a room operator a client can kick users from the room or ban them from the server, provided the operator's user permissions (as set in ES Admin) allow this to be done. If the kick succeeds, all users in the room get a UserEvictedFromRoomEvent giving the name of the user kicked and the reason.

var eur:EvictUserFromRoomRequest = new EvictUserFromRoomRequest();
eur.userName = userToKick;
eur.ban = false;
eur.duration = -1;
eur.roomId = _room.id;
eur.zoneId = _room.zoneId;
eur.reason = "you smell";

_es.engine.send(eur);

Method Documentation

- (void) fromThrift:

(id)

thriftObject

Reimplemented from EsMessage.

- (id) init

- (id) initWithThriftObject:

(id)

thriftObject

- (id) newThrift

Reimplemented from EsMessage.

- (ThriftUserEvictedFromRoomEvent *) toThrift

Reimplemented from EsMessage.

Property Documentation

- (BOOL) ban

readwritenonatomicassign

If true, then you are also banned from the server for an amount of time indicated by the duration property.

- (int32_t) duration

readwritenonatomicassign

The amount of time you are banned.

- (NSString*) reason

readwritenonatomicretain

Reason for being evicted, sent by the user who did the evicting.

- (int32_t) roomId

readwritenonatomicassign

Id of the room that contains the user that was evicted.

- (NSString*) userName

readwritenonatomicretain

- (int32_t) zoneId

readwritenonatomicassign

Id of the zone that contains the room that contains the user that was evicted.