| Package | com.electrotank.electroserver4.message |
| Class | public class MessageType |
import com.electrotank.electroserver4.ElectroServer;
import com.electrotank.electroserver4.message.request.
import com.electrotank.electroserver4.message.response.LoginResponse;
//
var es:ElectroServer;//assume a connection was made elsewhere
es.addEventListener(MessageType.LoginResponse, "onLoginResponse", this);
function onLoginResponse(e:LoginResponse):void {
//do something
}
import com.electrotank.electroserver4.message.Message;
import com.electrotank.electroserver4.message.MessageType;
import com.electrotank.electroserver4.message.request.
//
var messages:Array = new Array();
for (var i:int=0;i| Property | Defined by | ||
|---|---|---|---|
| AddBuddyRequest : MessageType
[static]
This variable refers to the AddBuddyRequest request.
| MessageType | ||
| AdditionalLoginRequest : MessageType
[static]
This variable refers to the AdditionalLoginRequest request.
| MessageType | ||
| AddRoomOperatorRequest : MessageType
[static]
This variable refers to the AddRoomOperatorRequest request.
| MessageType | ||
| BuddyStatusUpdatedEvent : MessageType
[static]
This variable refers to the BuddyStatusUpdatedEvent event.
| MessageType | ||
| ClientIdleEvent : MessageType
[static]
This variable refers to the ConnectionEvent event.
| MessageType | ||
| CompositePluginMessageEvent : MessageType
[static]
This variable refers to the CompositePluginMessageEvent event.
| MessageType | ||
| ConnectionClosedEvent : MessageType
[static]
This variable refers to the ConnectionClosedEvent event.
| MessageType | ||
| ConnectionEvent : MessageType
[static]
This variable refers to the ConnectionEvent event.
| MessageType | ||
| CreateOrJoinGameRequest : MessageType
[static]
This variable refers to the CreateOrJoinGameRequest request.
| MessageType | ||
| CreateOrJoinGameResponse : MessageType
[static]
This variable refers to the CreateOrJoinGameResponse response.
| MessageType | ||
| CreateRoomRequest : MessageType
[static]
This variable refers to the CreateRoomRequest request.
| MessageType | ||
| CreateRoomVariableRequest : MessageType
[static]
This variable refers to the CreateRoomVariableRequest request.
| MessageType | ||
| DeleteRoomVariableRequest : MessageType
[static]
This variable refers to the DeleteRoomVariableRequest request.
| MessageType | ||
| DeleteUserVariableRequest : MessageType
[static]
This variable refers to the DeleteUserVariableRequest request.
| MessageType | ||
| EvictUserFromRoomRequest : MessageType
[static]
This variable refers to the EvictUserFromRoomRequest request.
| MessageType | ||
| FindGamesRequest : MessageType
[static]
This variable refers to the FindGamesRequest request.
| MessageType | ||
| FindGamesResponse : MessageType
[static]
This variable refers to the FindGamesResponse response.
| MessageType | ||
| FindZoneAndRoomByNameRequest : MessageType
[static]
This variable refers to the FindZoneAndRoomByNameRequest request.
| MessageType | ||
| FindZoneAndRoomByNameResponse : MessageType
[static]
This variable refers to the FindZoneAndRoomByNameResponse response.
| MessageType | ||
| GateWayKickUserRequest : MessageType
[static]
This variable refers to the GateWayKickUserRequest request.
| MessageType | ||
| GenericErrorResponse : MessageType
[static]
This variable refers to the GenericErrorResponse response.
| MessageType | ||
| GetRoomsInZoneRequest : MessageType
[static]
This variable refers to the GetRoomsInZoneRequest request.
| MessageType | ||
| GetRoomsInZoneResponse : MessageType
[static]
This variable refers to the GetRoomsInZoneResponse response.
| MessageType | ||
| GetUserCountRequest : MessageType
[static]
This variable refers to the GetUserCountRequest request.
| MessageType | ||
| GetUserCountResponse : MessageType
[static]
This variable refers to the GetUserCountResponse response.
| MessageType | ||
| GetUsersInRoomRequest : MessageType
[static]
This variable refers to the GetUsersInRoomRequest request.
| MessageType | ||
| GetUsersInRoomResponse : MessageType
[static]
This variable refers to the GetUsersInRoomResponse response.
| MessageType | ||
| GetUserVariablesRequest : MessageType
[static]
This variable refers to the GetUserVariablesRequest request.
| MessageType | ||
| GetUserVariablesResponse : MessageType
[static]
This variable refers to the GetUserVariablesResponse response.
| MessageType | ||
| GetZonesRequest : MessageType
[static]
This variable refers to the GetZonesRequest request.
| MessageType | ||
| GetZonesResponse : MessageType
[static]
This variable refers to the GetZonesResponseresponse.
| MessageType | ||
| JoinRoomEvent : MessageType
[static]
This variable refers to the JoinRoomEvent event.
| MessageType | ||
| JoinRoomRequest : MessageType
[static]
This variable refers to the JoinRoomRequest request.
| MessageType | ||
| JoinZoneEvent : MessageType
[static]
This variable refers to the JoinZoneEvent event.
| MessageType | ||
| LeaveRoomEvent : MessageType
[static]
This variable refers to the LeaveRoomEvent event.
| MessageType | ||
| LeaveRoomRequest : MessageType
[static]
This variable refers to the LeaveRoomRequest request.
| MessageType | ||
| LeaveZoneEvent : MessageType
[static]
This variable refers to the LeaveZoneEvent event.
| MessageType | ||
| LoginRequest : MessageType
[static]
This variable refers to the LoginRequest request.
| MessageType | ||
| LoginResponse : MessageType
[static]
This variable refers to the LoginResponse response.
| MessageType | ||
| LogoutRequest : MessageType
[static]
This variable refers to the LogoutRequest request.
| MessageType | ||
| PluginMessageEvent : MessageType
[static]
This variable refers to the PluginMessageEvent event.
| MessageType | ||
| PluginRequest : MessageType
[static]
This variable refers to the PluginRequest request.
| MessageType | ||
| PrivateMessageEvent : MessageType
[static]
This variable refers to the PrivateMessageEvent event.
| MessageType | ||
| PrivateMessageRequest : MessageType
[static]
This variable refers to the PrivateMessageRequest request.
| MessageType | ||
| PublicMessageEvent : MessageType
[static]
This variable refers to the PublicMessageEvent event.
| MessageType | ||
| PublicMessageRequest : MessageType
[static]
This variable refers to the PublicMessageRequest request.
| MessageType | ||
| RemoveBuddyRequest : MessageType
[static]
This variable refers to the RemoveBuddyRequest request.
| MessageType | ||
| RemoveRoomOperatorRequest : MessageType
[static]
This variable refers to the RemoveRoomOperatorRequest request.
| MessageType | ||
| RoomVariableUpdateEvent : MessageType
[static]
This variable refers to the RoomVariableUpdateEvent event.
| MessageType | ||
| RtmpConnectionClosedEvent : MessageType
[static]
This variable refers to the RtmpConnectionClosedEvent event.
| MessageType | ||
| RtmpConnectionEvent : MessageType
[static]
This variable refers to the RtmpConnectionEvent event.
| MessageType | ||
| RtmpOnStatusEvent : MessageType
[static]
This variable refers to the RtmpOnStatusEvent event.
| MessageType | ||
| UpdateRoomDetailsEvent : MessageType
[static]
This variable refers to the UpdateRoomDetailsEvent event.
| MessageType | ||
| UpdateRoomDetailsRequest : MessageType
[static]
This variable refers to the UpdateRoomDetailsRequest request.
| MessageType | ||
| UpdateRoomVariableRequest : MessageType
[static]
This variable refers to the UpdateRoomVariableRequest request.
| MessageType | ||
| UpdateUserVariableRequest : MessageType
[static]
This variable refers to the UpdateUserVariableRequest request.
| MessageType | ||
| UserEvictedFromRoomEvent : MessageType
[static]
This variable refers to the UserEvictedFromRoomEvent event.
| MessageType | ||
| UserListUpdateEvent : MessageType
[static]
This variable refers to the UserListUpdateEvent event.
| MessageType | ||
| UserVariableUpdateEvent : MessageType
[static]
This variable refers to the UserVariableUpdateEvent event.
| MessageType | ||
| ValidateAdditionalLoginRequest : MessageType
[static]
This variable refers to the ValidateAdditionalLoginRequest request.
| MessageType | ||
| ValidateAdditionalLoginResponse : MessageType
[static]
This variable refers to the ValidateAdditionalLoginResponse response.
| MessageType | ||
| ZoneUpdateEvent : MessageType
[static]
This variable refers to the ZoneUpdateEvent event.
| MessageType | ||
| Method | Defined by | ||
|---|---|---|---|
|
MessageType(id:String, name:String, req:Boolean, res:Boolean, ev:Boolean)
Creates a new instance of the MessageType class.
| MessageType | ||
|
findTypeById(id:String):MessageType
[static]
Every message has a unique id.
| MessageType | ||
|
getIsEvent():Boolean
Gets the isEvent property.
| MessageType | ||
|
getIsRequest():Boolean
Gets the isRequest property.
| MessageType | ||
|
getIsResponse():Boolean
Gets the isResponse property.
| MessageType | ||
|
getMessageTypeId():String
The message type id.
| MessageType | ||
|
getMessageTypeName():String
Gets the message type name.
| MessageType | ||
|
setIsEvent(val:Boolean):void
Sets the isEvent property.
| MessageType | ||
|
setIsRequest(val:Boolean):void
Sets the isRequst property.
| MessageType | ||
|
setIsResponse(val:Boolean):void
Sets the isResponse property.
| MessageType | ||
|
setMessageTypeId(id:String):void
Sets the message type id.
| MessageType | ||
|
setMessageTypeName(name:String):void
Sets the message type name.
| MessageType | ||
| AddBuddyRequest | property |
public static var AddBuddyRequest:MessageTypeThis variable refers to the AddBuddyRequest request.
| AdditionalLoginRequest | property |
public static var AdditionalLoginRequest:MessageTypeThis variable refers to the AdditionalLoginRequest request.
| AddRoomOperatorRequest | property |
public static var AddRoomOperatorRequest:MessageTypeThis variable refers to the AddRoomOperatorRequest request.
| BuddyStatusUpdatedEvent | property |
public static var BuddyStatusUpdatedEvent:MessageTypeThis variable refers to the BuddyStatusUpdatedEvent event.
| ClientIdleEvent | property |
public static var ClientIdleEvent:MessageTypeThis variable refers to the ConnectionEvent event.
| CompositePluginMessageEvent | property |
public static var CompositePluginMessageEvent:MessageTypeThis variable refers to the CompositePluginMessageEvent event.
| ConnectionClosedEvent | property |
public static var ConnectionClosedEvent:MessageTypeThis variable refers to the ConnectionClosedEvent event.
| ConnectionEvent | property |
public static var ConnectionEvent:MessageTypeThis variable refers to the ConnectionEvent event.
| CreateOrJoinGameRequest | property |
public static var CreateOrJoinGameRequest:MessageTypeThis variable refers to the CreateOrJoinGameRequest request.
| CreateOrJoinGameResponse | property |
public static var CreateOrJoinGameResponse:MessageTypeThis variable refers to the CreateOrJoinGameResponse response.
| CreateRoomRequest | property |
public static var CreateRoomRequest:MessageTypeThis variable refers to the CreateRoomRequest request.
| CreateRoomVariableRequest | property |
public static var CreateRoomVariableRequest:MessageTypeThis variable refers to the CreateRoomVariableRequest request.
| DeleteRoomVariableRequest | property |
public static var DeleteRoomVariableRequest:MessageTypeThis variable refers to the DeleteRoomVariableRequest request.
| DeleteUserVariableRequest | property |
public static var DeleteUserVariableRequest:MessageTypeThis variable refers to the DeleteUserVariableRequest request.
| EvictUserFromRoomRequest | property |
public static var EvictUserFromRoomRequest:MessageTypeThis variable refers to the EvictUserFromRoomRequest request.
| FindGamesRequest | property |
public static var FindGamesRequest:MessageTypeThis variable refers to the FindGamesRequest request.
| FindGamesResponse | property |
public static var FindGamesResponse:MessageTypeThis variable refers to the FindGamesResponse response.
| FindZoneAndRoomByNameRequest | property |
public static var FindZoneAndRoomByNameRequest:MessageTypeThis variable refers to the FindZoneAndRoomByNameRequest request.
| FindZoneAndRoomByNameResponse | property |
public static var FindZoneAndRoomByNameResponse:MessageTypeThis variable refers to the FindZoneAndRoomByNameResponse response.
| GateWayKickUserRequest | property |
public static var GateWayKickUserRequest:MessageTypeThis variable refers to the GateWayKickUserRequest request.
| GenericErrorResponse | property |
public static var GenericErrorResponse:MessageTypeThis variable refers to the GenericErrorResponse response.
| GetRoomsInZoneRequest | property |
public static var GetRoomsInZoneRequest:MessageTypeThis variable refers to the GetRoomsInZoneRequest request.
| GetRoomsInZoneResponse | property |
public static var GetRoomsInZoneResponse:MessageTypeThis variable refers to the GetRoomsInZoneResponse response.
| GetUserCountRequest | property |
public static var GetUserCountRequest:MessageTypeThis variable refers to the GetUserCountRequest request.
| GetUserCountResponse | property |
public static var GetUserCountResponse:MessageTypeThis variable refers to the GetUserCountResponse response.
| GetUsersInRoomRequest | property |
public static var GetUsersInRoomRequest:MessageTypeThis variable refers to the GetUsersInRoomRequest request.
| GetUsersInRoomResponse | property |
public static var GetUsersInRoomResponse:MessageTypeThis variable refers to the GetUsersInRoomResponse response.
| GetUserVariablesRequest | property |
public static var GetUserVariablesRequest:MessageTypeThis variable refers to the GetUserVariablesRequest request.
| GetUserVariablesResponse | property |
public static var GetUserVariablesResponse:MessageTypeThis variable refers to the GetUserVariablesResponse response.
| GetZonesRequest | property |
public static var GetZonesRequest:MessageTypeThis variable refers to the GetZonesRequest request.
| GetZonesResponse | property |
public static var GetZonesResponse:MessageTypeThis variable refers to the GetZonesResponseresponse.
| JoinRoomEvent | property |
public static var JoinRoomEvent:MessageTypeThis variable refers to the JoinRoomEvent event.
| JoinRoomRequest | property |
public static var JoinRoomRequest:MessageTypeThis variable refers to the JoinRoomRequest request.
| JoinZoneEvent | property |
public static var JoinZoneEvent:MessageTypeThis variable refers to the JoinZoneEvent event.
| LeaveRoomEvent | property |
public static var LeaveRoomEvent:MessageTypeThis variable refers to the LeaveRoomEvent event.
| LeaveRoomRequest | property |
public static var LeaveRoomRequest:MessageTypeThis variable refers to the LeaveRoomRequest request.
| LeaveZoneEvent | property |
public static var LeaveZoneEvent:MessageTypeThis variable refers to the LeaveZoneEvent event.
| LoginRequest | property |
public static var LoginRequest:MessageTypeThis variable refers to the LoginRequest request.
| LoginResponse | property |
public static var LoginResponse:MessageTypeThis variable refers to the LoginResponse response.
| LogoutRequest | property |
public static var LogoutRequest:MessageTypeThis variable refers to the LogoutRequest request.
| PluginMessageEvent | property |
public static var PluginMessageEvent:MessageTypeThis variable refers to the PluginMessageEvent event.
| PluginRequest | property |
public static var PluginRequest:MessageTypeThis variable refers to the PluginRequest request.
| PrivateMessageEvent | property |
public static var PrivateMessageEvent:MessageTypeThis variable refers to the PrivateMessageEvent event.
| PrivateMessageRequest | property |
public static var PrivateMessageRequest:MessageTypeThis variable refers to the PrivateMessageRequest request.
| PublicMessageEvent | property |
public static var PublicMessageEvent:MessageTypeThis variable refers to the PublicMessageEvent event.
| PublicMessageRequest | property |
public static var PublicMessageRequest:MessageTypeThis variable refers to the PublicMessageRequest request.
| RemoveBuddyRequest | property |
public static var RemoveBuddyRequest:MessageTypeThis variable refers to the RemoveBuddyRequest request.
| RemoveRoomOperatorRequest | property |
public static var RemoveRoomOperatorRequest:MessageTypeThis variable refers to the RemoveRoomOperatorRequest request.
| RoomVariableUpdateEvent | property |
public static var RoomVariableUpdateEvent:MessageTypeThis variable refers to the RoomVariableUpdateEvent event.
| RtmpConnectionClosedEvent | property |
public static var RtmpConnectionClosedEvent:MessageTypeThis variable refers to the RtmpConnectionClosedEvent event.
| RtmpConnectionEvent | property |
public static var RtmpConnectionEvent:MessageTypeThis variable refers to the RtmpConnectionEvent event.
| RtmpOnStatusEvent | property |
public static var RtmpOnStatusEvent:MessageTypeThis variable refers to the RtmpOnStatusEvent event.
| UpdateRoomDetailsEvent | property |
public static var UpdateRoomDetailsEvent:MessageTypeThis variable refers to the UpdateRoomDetailsEvent event.
| UpdateRoomDetailsRequest | property |
public static var UpdateRoomDetailsRequest:MessageTypeThis variable refers to the UpdateRoomDetailsRequest request.
| UpdateRoomVariableRequest | property |
public static var UpdateRoomVariableRequest:MessageTypeThis variable refers to the UpdateRoomVariableRequest request.
| UpdateUserVariableRequest | property |
public static var UpdateUserVariableRequest:MessageTypeThis variable refers to the UpdateUserVariableRequest request.
| UserEvictedFromRoomEvent | property |
public static var UserEvictedFromRoomEvent:MessageTypeThis variable refers to the UserEvictedFromRoomEvent event.
| UserListUpdateEvent | property |
public static var UserListUpdateEvent:MessageTypeThis variable refers to the UserListUpdateEvent event.
| UserVariableUpdateEvent | property |
public static var UserVariableUpdateEvent:MessageTypeThis variable refers to the UserVariableUpdateEvent event.
| ValidateAdditionalLoginRequest | property |
public static var ValidateAdditionalLoginRequest:MessageTypeThis variable refers to the ValidateAdditionalLoginRequest request.
| ValidateAdditionalLoginResponse | property |
public static var ValidateAdditionalLoginResponse:MessageTypeThis variable refers to the ValidateAdditionalLoginResponse response.
| ZoneUpdateEvent | property |
public static var ZoneUpdateEvent:MessageTypeThis variable refers to the ZoneUpdateEvent event.
| MessageType | () | constructor |
public function MessageType(id:String, name:String, req:Boolean, res:Boolean, ev:Boolean)Creates a new instance of the MessageType class. Pass in the message type id, which should be unique, the name, and boolean values to set if it is a request, event, or response.
Parametersid:String — The unique message type id.
|
|
name:String — The name of the message.
|
|
req:Boolean — isRequest - true/false
|
|
res:Boolean — isResponse - true/false
|
|
ev:Boolean — isEvent - true/false
|
| findTypeById | () | method |
public static function findTypeById(id:String):MessageTypeEvery message has a unique id. This id is used on the server and the client. This method allows you to find the message type base don the id.
Parametersid:String — The message type id.
|
MessageType —
The MessageType class associated in the id.
|
| getIsEvent | () | method |
public function getIsEvent():BooleanGets the isEvent property.
ReturnsBoolean — True or false.
|
| getIsRequest | () | method |
public function getIsRequest():BooleanGets the isRequest property.
ReturnsBoolean — True or false.
|
| getIsResponse | () | method |
public function getIsResponse():BooleanGets the isResponse property.
ReturnsBoolean — True or false.
|
| getMessageTypeId | () | method |
public function getMessageTypeId():StringThe message type id.
ReturnsString — The message type id.
|
| getMessageTypeName | () | method |
public function getMessageTypeName():StringGets the message type name.
ReturnsString — The message type name.
|
| setIsEvent | () | method |
public function setIsEvent(val:Boolean):voidSets the isEvent property.
Parametersval:Boolean — True or false.
|
| setIsRequest | () | method |
public function setIsRequest(val:Boolean):voidSets the isRequst property.
Parametersval:Boolean — True or false.
|
| setIsResponse | () | method |
public function setIsResponse(val:Boolean):voidSets the isResponse property.
Parametersval:Boolean — True or false.
|
| setMessageTypeId | () | method |
public function setMessageTypeId(id:String):voidSets the message type id. This must be a unique value.
Parametersid:String — The message type id.
|
| setMessageTypeName | () | method |
public function setMessageTypeName(name:String):voidSets the message type name. This is used for friendly logging.
Parametersname:String — Name of the message type.
|