ElectroServer 5 Client: C#
Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest Class Reference

This request can be made by a current room operator to remove operator status from another user in the room. More...

Inheritance diagram for Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest:
Electrotank.Electroserver5.Api.EsRequest Electrotank.Electroserver5.Api.EsMessage Electrotank.Electroserver5.Api.IThriftSerializable

Public Member Functions

 RemoveRoomOperatorRequest ()
 
 RemoveRoomOperatorRequest (TBase t)
 
override TBase ToThrift ()
 
override TBase NewThrift ()
 
override void FromThrift (TBase t_)
 

Properties

int ZoneId [get, set]
 Id of the zone that contains the room that contains the user in question. More...
 
int RoomId [get, set]
 Id of the room that contains the user in question. More...
 
string UserName [get, set]
 

Detailed Description

This request can be made by a current room operator to remove operator status from another user in the room.

By default the first user in a room is a room operator. The operator has the power to kick users from the room and to give operator status to other users, and to revoke operator status from other users. You know when your operator status changes because the 'action' property on the RoomUserUpdateEvent is OperatorGranted or OperatorRevoked.

      This example shows how one operator can remove operator status from another user.
private var _es:ElectroServer;
private var _room:Room;
private function initialize():void {
        _es.engine.addEventListener(MessageType.RoomUserUpdateEvent.name, onRoomUserUpdateEvent);
        var rror:RemoveRoomOperatorRequest = new RemoveRoomOperatorRequest();
        rror.zoneId = _room.zoneId;
        rror.roomId = _room.id;
        rror.userName = "mike";
        _es.engine.send(rror);
}
private function onRoomUserUpdateEvent(e:RoomUserUpdateEvent):void {
        switch (e.action) {
                case RoomUserUpdateAction.OperatorGranted:
                        trace(e.userName + " was granted operator status.");
                        break;
                case RoomUserUpdateAction.OperatorRevoked:
                        trace(e.userName + " had operator status revoked.");
                        break;
        }
}
 

Constructor & Destructor Documentation

Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.RemoveRoomOperatorRequest ( )
Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.RemoveRoomOperatorRequest ( TBase  t)

Member Function Documentation

override void Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.FromThrift ( TBase  t_)
virtual
override TBase Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.NewThrift ( )
virtual
override TBase Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.ToThrift ( )
virtual

Property Documentation

int Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.RoomId
getset

Id of the room that contains the user in question.

string Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.UserName
getset
int Electrotank.Electroserver5.Api.RemoveRoomOperatorRequest.ZoneId
getset

Id of the zone that contains the room that contains the user in question.