ElectroServer 5 Client: C#
Package Electrotank.Electroserver5.Api

Autogenerated by CsharpApiGenerator. More...

Namespaces

package  Helper
 

Classes

class  EsEntity
 
class  EsEvent
 
class  EsMessage
 
class  EsObject
 
class  EsObjectDataHolder
 
interface  EsObjectRO
 
class  EsRequest
 
class  EsResponse
 
class  EsUnknownMessage
 
interface  IThriftSerializable
 
class  Number
 
class  ClientType
 
class  AddBuddiesRequest
 This request adds an array of users to your buddy list. More...
 
class  AddBuddiesResponse
 
      This is a response to an AddBuddiesRequest, detailing for each user listed

in the request whether the user was added as a buddy or not. More...

 
class  AddRoomOperatorRequest
 This request can be made by a current room operator to give operator status to another user in the room. More...
 
class  AggregatePluginMessageEvent
 Most games have a server plugin that contains custom game logic. More...
 
class  AggregatePluginRequest
 Most games are event driven, and they communicate with the server when an important event happens on the client. More...
 
class  BuddyStatusUpdateEvent
 A buddy is either logged in or not. More...
 
class  ConnectionAttemptResponse
 Before a client can do anything with the server a connection must be established. More...
 
class  ConnectionClosedEvent
 When a connection closes this event occurs. More...
 
class  ConnectionResponse
 Before a client can do anything with the server a connection must be established. More...
 
class  CreateOrJoinGameResponse
 The QuickJoinGameRequest is used to create a new game on the server, or to join a game that matches the criteria passed in. More...
 
class  CreateRoomRequest
 This class represents a highly flexible server request. More...
 
class  CreateRoomVariableRequest
 This request creates a room variable. More...
 
class  CrossDomainPolicyRequest
 
class  CrossDomainPolicyResponse
 
class  DeleteRoomVariableRequest
 This request deletes a room variable. More...
 
class  DeleteUserVariableRequest
 This request deletes a user variable. More...
 
class  DHInitiateKeyExchangeRequest
 
class  DHPublicNumbersResponse
 
class  DHSharedModulusRequest
 
class  DHSharedModulusResponse
 
class  EncryptionStateChangeEvent
 Event fired when the encryption state of a client changes. More...
 
class  EsNumber
 
class  EvictUserFromRoomRequest
 By default, the first client joined to a room is the room operator. More...
 
class  FindGamesRequest
 This request allows a client to request a list of games that are managed by the server. More...
 
class  FindGamesResponse
 The FindGamesRequest allows a client to request a list of games that are managed by the server. More...
 
class  FindZoneAndRoomByNameRequest
 Knowing the name of a room and the name of a zone you can request the id of the room and the id of the zone. More...
 
class  FindZoneAndRoomByNameResponse
 Knowing the name of a room and the name of a zone you can request the id of the room and the id of the zone. More...
 
class  FlattenedEsObject
 
class  FlattenedEsObjectRO
 
class  GatewayKickUserRequest
 
class  GatewayStatistics
 
class  GenericErrorResponse
 When the client sends a request that request can lead to a server error, or just a failure. More...
 
class  GetGameTypesRequest
 This request asks the server for a list of registered gametypes. More...
 
class  GetGameTypesResponse
 
      When a client sends a GetGameTypesRequest it leads to this response, which

contains a list of all gameTypes currently registered with GameManager. More...

 
class  GetRoomsInZoneRequest
 This request allows the client to ask for a list of all of the rooms in a specific zone. More...
 
class  GetRoomsInZoneResponse
 This the response to the GetRoomsInZoneRequest. More...
 
class  GetServerLocalTimeRequest
 Requests a timestamp from the server. More...
 
class  GetServerLocalTimeResponse
 Response to a GetServerLocalTimeRequest. More...
 
class  GetUserCountRequest
 This request asks the server for the current number of users logged in. More...
 
class  GetUserCountResponse
 This is the response to the GetUserCountRequest. More...
 
class  GetUsersInRoomRequest
 This request allows a client to load the list of users in any room. More...
 
class  GetUsersInRoomResponse
 This is the response to the GetUsersInRoomRequest. More...
 
class  GetUserVariablesRequest
 Loads a list of user variables for the specified userName. More...
 
class  GetUserVariablesResponse
 GetUserVariablesRequest loads a list of user variables for the specified userName, and this class is the response. More...
 
class  GetZonesRequest
 This request get the list of zones on the server. More...
 
class  GetZonesResponse
 When a client sends a GetZonesRequest it leads to this response. More...
 
class  IdleTimeoutWarningEvent
 
      When a user is in danger of being kicked from the server due to idleness, 

this event occurs. More...

 
class  JoinGameRequest
 
class  JoinRoomEvent
 When a user is joined successfully to a room this event occurs. More...
 
class  JoinRoomRequest
 If you know that a specific room already exists, then you can join it using this request. More...
 
class  JoinZoneEvent
 A zone is a collection of rooms. More...
 
class  LeaveRoomEvent
 When a user leaves a room this event occurs. More...
 
class  LeaveRoomRequest
 When a user wants to leave a room it can be done via this request. More...
 
class  LeaveZoneEvent
 When a user leaves all rooms in a zone this event occurs. More...
 
class  LoginRequest
 This message is sent by the client to the server (after establishing a connection) to attempt to login. More...
 
class  LoginResponse
 After a client attempts a login via the LoginRequest message the server responds with this message. More...
 
class  LogOutRequest
 
class  PingRequest
 
class  PingResponse
 
class  PluginListEntry
 
class  PluginMessageEvent
 This even occurs when a message from a plugin is received. More...
 
class  PluginRequest
 This class is used to send a message to a plugin. More...
 
class  PrivateMessageEvent
 This event occurs when a client receives a private message from another user. More...
 
class  PrivateMessageRequest
 This request is used to send private messages to one or more users at once. More...
 
class  ProtocolConfiguration
 
class  PublicMessageEvent
 This event occurs when a public message is sent to a room to which the client belongs. More...
 
class  PublicMessageRequest
 This class is used to send a public message to a room that the user is in. More...
 
class  QuickJoinGameRequest
 This request is used to create a new game on the server, or to join a game that matches the criteria passed in. More...
 
class  RegisterUDPConnectionRequest
 
class  RegisterUDPConnectionResponse
 
class  RegistryConnectToPreferredGatewayRequest
 
class  RemoveBuddiesRequest
 This request removes a user from a client's buddy list. More...
 
class  RemoveBuddiesResponse
 
      This is a response to a RemoveBuddiesRequest, detailing for each user listed

in the request whether the user was removed as a buddy or not. More...

 
class  RemoveRoomOperatorRequest
 This request can be made by a current room operator to remove operator status from another user in the room. More...
 
class  RemoveUDPConnectionRequest
 
class  RemoveUDPConnectionResponse
 
class  RequestDetails
 
class  RoomListEntry
 
class  RoomVariable
 
class  RoomVariableUpdateEvent
 When a room variable is created, deleted, or updated in a room that the client belongs to then this event occurs. More...
 
class  SearchCriteria
 
class  ServerGame
 
class  ServerKickUserEvent
 When a user is kicked from the server, this event occurs. More...
 
class  SessionIdleEvent
 This event occurs if the client has been idle (not sending any messages to the server) for an amount of time that is equal to or greater than the maximum time allowed for idling. More...
 
class  UpdateRoomDetailsEvent
 Certain properties of a room can be updated by a user in that room after the room has been created. More...
 
class  UpdateRoomDetailsRequest
 Certain properties of a room can be updated by a user in that room after the room has been created. More...
 
class  UpdateRoomVariableRequest
 
class  UpdateUserVariableRequest
 This request creates or updates a user variable. More...
 
class  UserEvictedFromRoomEvent
 By default, the first client joined to a room is the room operator. More...
 
class  UserListEntry
 
class  UserServerVariable
 
class  UserUpdateEvent
 The user list can change when a client is in a room, and properties on a user can also change. More...
 
class  UserVariable
 
class  UserVariableUpdateEvent
 This event occurs whenever a user variable is created, updated, or removed. More...
 
class  Utility
 
class  ValidateAdditionalLoginRequest
 This request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer. More...
 
class  ValidateAdditionalLoginResponse
 This request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer. More...
 
class  ZoneListEntry
 
class  ZoneUpdateEvent
 This event occurs when the room list changes in a zone that your client can see, or when a public property on a room in that zone changes. More...
 

Enumerations

enum  BuddyStatusUpdateAction { BuddyStatusUpdateAction.LoggedIn, BuddyStatusUpdateAction.LoggedOut }
 
enum  DataType {
  DataType.Integer, DataType.String, DataType.Double, DataType.Float,
  DataType.Boolean, DataType.Byte, DataType.Character, DataType.Long,
  DataType.Short, DataType.EsObject, DataType.EsObjectArray, DataType.IntegerArray,
  DataType.StringArray, DataType.DoubleArray, DataType.FloatArray, DataType.BooleanArray,
  DataType.ByteArray, DataType.CharacterArray, DataType.LongArray, DataType.ShortArray,
  DataType.Number, DataType.NumberArray
}
 
enum  ErrorType {
  ErrorType.UserNameExists, ErrorType.UserAlreadyLoggedIn, ErrorType.InvalidMessageNumber, ErrorType.InboundMessageFailedValidation,
  ErrorType.MaximumClientConnectionsReached, ErrorType.ZoneNotFound, ErrorType.RoomNotFound, ErrorType.RoomAtCapacity,
  ErrorType.RoomPasswordMismatch, ErrorType.GatewayPaused, ErrorType.AccessDenied, ErrorType.RoomVariableLocked,
  ErrorType.RoomVariableAlreadyExists, ErrorType.DuplicateRoomName, ErrorType.DuplicateZoneName, ErrorType.UserVariableAlreadyExists,
  ErrorType.UserVariableDoesNotExist, ErrorType.ZoneAllocationFailure, ErrorType.RoomAllocationFailure, ErrorType.UserBanned,
  ErrorType.UserAlreadyInRoom, ErrorType.LanguageFilterCheckFailed, ErrorType.RegistryTransactionEncounteredError, ErrorType.ActionRequiresLogin,
  ErrorType.GenericError, ErrorType.PluginNotFound, ErrorType.LoginEventHandlerFailure, ErrorType.InvalidUserName,
  ErrorType.ExtensionNotFound, ErrorType.PluginInitializationFailed, ErrorType.EventNotFound, ErrorType.FloodingFilterCheckFailed,
  ErrorType.UserNotJoinedToRoom, ErrorType.ManagedObjectNotFound, ErrorType.IdleTimeReached, ErrorType.ServerError,
  ErrorType.OperationNotSupported, ErrorType.InvalidLanguageFilterSettings, ErrorType.InvalidFloodingFilterSettings, ErrorType.ExtensionForcedReload,
  ErrorType.UserLogOutRequested, ErrorType.OnlyRtmpConnectionRemains, ErrorType.GameDoesntExist, ErrorType.FailedToJoinGameRoom,
  ErrorType.GameIsLocked, ErrorType.InvalidParameters, ErrorType.PublicMessageRejected, ErrorType.UserKickedFromServer,
  ErrorType.LanguageFilterNotFound, ErrorType.InvalidCryptoState, ErrorType.FloodingFilterNotFound, ErrorType.ConnectionFailed,
  ErrorType.MultipleZonesFound, ErrorType.MultipleRoomsFound, ErrorType.LoginsAreDisabled, ErrorType.ClientDroppedConnection
}
 
enum  MessageType {
  MessageType.CrossDomainRequest, MessageType.CreateRoomRequest, MessageType.JoinRoomRequest, MessageType.LoginRequest,
  MessageType.LogOutRequest, MessageType.ValidateAdditionalLoginRequest, MessageType.ValidateAdditionalLoginResponse, MessageType.PublicMessageRequest,
  MessageType.PrivateMessageRequest, MessageType.LeaveRoomRequest, MessageType.CreateRoomVariableRequest, MessageType.DeleteRoomVariableRequest,
  MessageType.UpdateRoomVariableRequest, MessageType.GetZonesRequest, MessageType.GetRoomsInZoneRequest, MessageType.UpdateRoomDetailsRequest,
  MessageType.AddRoomOperatorRequest, MessageType.RemoveRoomOperatorRequest, MessageType.FindZoneAndRoomByNameRequest, MessageType.GetUsersInRoomRequest,
  MessageType.DeleteUserVariableRequest, MessageType.UpdateUserVariableRequest, MessageType.AddBuddiesRequest, MessageType.RemoveBuddiesRequest,
  MessageType.EvictUserFromRoomRequest, MessageType.GetUserCountRequest, MessageType.PluginRequest, MessageType.CreateOrJoinGameRequest,
  MessageType.JoinGameRequest, MessageType.FindGamesRequest, MessageType.GetUserVariablesRequest, MessageType.AggregatePluginRequest,
  MessageType.GetServerLocalTimeRequest, MessageType.GetGameTypesRequest, MessageType.ConnectionResponse, MessageType.CrossDomainResponse,
  MessageType.LoginResponse, MessageType.GetZonesResponse, MessageType.GetRoomsInZoneResponse, MessageType.GenericErrorResponse,
  MessageType.FindZoneAndRoomByNameResponse, MessageType.GetUsersInRoomResponse, MessageType.GetUserCountResponse, MessageType.CreateOrJoinGameResponse,
  MessageType.FindGamesResponse, MessageType.GetUserVariablesResponse, MessageType.AddBuddiesResponse, MessageType.RemoveBuddiesResponse,
  MessageType.GetServerLocalTimeResponse, MessageType.GetGameTypesResponse, MessageType.PublicMessageEvent, MessageType.PrivateMessageEvent,
  MessageType.SessionIdleEvent, MessageType.JoinRoomEvent, MessageType.JoinZoneEvent, MessageType.UserUpdateEvent,
  MessageType.ZoneUpdateEvent, MessageType.LeaveRoomEvent, MessageType.LeaveZoneEvent, MessageType.RoomVariableUpdateEvent,
  MessageType.UpdateRoomDetailsEvent, MessageType.BuddyStatusUpdatedEvent, MessageType.UserEvictedFromRoomEvent, MessageType.UserVariableUpdateEvent,
  MessageType.PluginMessageEvent, MessageType.AggregatePluginMessageEvent, MessageType.RegistryConnectToPreferredGatewayRequest, MessageType.DisconnectedEvent,
  MessageType.GatewayStartupExceptionsMessage, MessageType.RegistryLoginResponse, MessageType.RegistryConnectionResponse, MessageType.GatewayKickUserRequest,
  MessageType.ServerKickUserEvent, MessageType.UdpBackchannelEvent, MessageType.Unknown, MessageType.RtmpPlayVideo,
  MessageType.RtmpEventResponse, MessageType.RtmpRecordVideo, MessageType.RtmpPublishVideo, MessageType.RtmpUnpublishVideo,
  MessageType.RtmpAppendVideo, MessageType.RtmpStreamingStart, MessageType.RtmpStreamingStop, MessageType.DHInitiate,
  MessageType.DHPublicNumbers, MessageType.DHSharedModulusRequest, MessageType.DHSharedModulusResponse, MessageType.EncryptionStateChange,
  MessageType.ConnectionAttemptResponse, MessageType.ConnectionClosedEvent, MessageType.RegisterUDPConnectionRequest, MessageType.RegisterUDPConnectionResponse,
  MessageType.RemoveUDPConnectionRequest, MessageType.RemoveUDPConnectionResponse, MessageType.PingRequest, MessageType.PingResponse,
  MessageType.IdleTimeoutWarningEvent, MessageType.MarkGatewayClientLoggedInMessage
}
 
enum  Protocol {
  Protocol.BinaryTCP, Protocol.RTMP, Protocol.BinaryHTTP, Protocol.TextTCP,
  Protocol.BinaryUDP
}
 
enum  RoomVariableUpdateAction { RoomVariableUpdateAction.VariableCreated, RoomVariableUpdateAction.VariableUpdated, RoomVariableUpdateAction.VariableDeleted }
 
enum  ServerState { ServerState.NOOP, ServerState.RUNNING, ServerState.PAUSED, ServerState.STOPPED }
 
enum  UserUpdateAction {
  UserUpdateAction.AddUser, UserUpdateAction.DeleteUser, UserUpdateAction.OperatorGranted, UserUpdateAction.OperatorRevoked,
  UserUpdateAction.SendingVideoStream, UserUpdateAction.StoppingVideoStream
}
 
enum  UserVariableUpdateAction { UserVariableUpdateAction.VariableCreated, UserVariableUpdateAction.VariableUpdated, UserVariableUpdateAction.VariableDeleted }
 
enum  ZoneUpdateAction { ZoneUpdateAction.AddRoom, ZoneUpdateAction.DeleteRoom, ZoneUpdateAction.UpdateRoom }
 

Detailed Description

Autogenerated by CsharpApiGenerator.

DO NOT EDIT

Enumeration Type Documentation

Enumerator
LoggedIn 
LoggedOut 
Enumerator
Integer 
String 
Double 
Float 
Boolean 
Byte 
Character 
Long 
Short 
EsObject 
EsObjectArray 
IntegerArray 
StringArray 
DoubleArray 
FloatArray 
BooleanArray 
ByteArray 
CharacterArray 
LongArray 
ShortArray 
Number 
NumberArray 
Enumerator
UserNameExists 
UserAlreadyLoggedIn 
InvalidMessageNumber 
InboundMessageFailedValidation 
MaximumClientConnectionsReached 
ZoneNotFound 
RoomNotFound 
RoomAtCapacity 
RoomPasswordMismatch 
GatewayPaused 
AccessDenied 
RoomVariableLocked 
RoomVariableAlreadyExists 
DuplicateRoomName 
DuplicateZoneName 
UserVariableAlreadyExists 
UserVariableDoesNotExist 
ZoneAllocationFailure 
RoomAllocationFailure 
UserBanned 
UserAlreadyInRoom 
LanguageFilterCheckFailed 
RegistryTransactionEncounteredError 
ActionRequiresLogin 
GenericError 
PluginNotFound 
LoginEventHandlerFailure 
InvalidUserName 
ExtensionNotFound 
PluginInitializationFailed 
EventNotFound 
FloodingFilterCheckFailed 
UserNotJoinedToRoom 
ManagedObjectNotFound 
IdleTimeReached 
ServerError 
OperationNotSupported 
InvalidLanguageFilterSettings 
InvalidFloodingFilterSettings 
ExtensionForcedReload 
UserLogOutRequested 
OnlyRtmpConnectionRemains 
GameDoesntExist 
FailedToJoinGameRoom 
GameIsLocked 
InvalidParameters 
PublicMessageRejected 
UserKickedFromServer 
LanguageFilterNotFound 
InvalidCryptoState 
FloodingFilterNotFound 
ConnectionFailed 
MultipleZonesFound 
MultipleRoomsFound 
LoginsAreDisabled 
ClientDroppedConnection 
Enumerator
CrossDomainRequest 
CreateRoomRequest 
JoinRoomRequest 
LoginRequest 
LogOutRequest 
ValidateAdditionalLoginRequest 
ValidateAdditionalLoginResponse 
PublicMessageRequest 
PrivateMessageRequest 
LeaveRoomRequest 
CreateRoomVariableRequest 
DeleteRoomVariableRequest 
UpdateRoomVariableRequest 
GetZonesRequest 
GetRoomsInZoneRequest 
UpdateRoomDetailsRequest 
AddRoomOperatorRequest 
RemoveRoomOperatorRequest 
FindZoneAndRoomByNameRequest 
GetUsersInRoomRequest 
DeleteUserVariableRequest 
UpdateUserVariableRequest 
AddBuddiesRequest 
RemoveBuddiesRequest 
EvictUserFromRoomRequest 
GetUserCountRequest 
PluginRequest 
CreateOrJoinGameRequest 
JoinGameRequest 
FindGamesRequest 
GetUserVariablesRequest 
AggregatePluginRequest 
GetServerLocalTimeRequest 
GetGameTypesRequest 
ConnectionResponse 
CrossDomainResponse 
LoginResponse 
GetZonesResponse 
GetRoomsInZoneResponse 
GenericErrorResponse 
FindZoneAndRoomByNameResponse 
GetUsersInRoomResponse 
GetUserCountResponse 
CreateOrJoinGameResponse 
FindGamesResponse 
GetUserVariablesResponse 
AddBuddiesResponse 
RemoveBuddiesResponse 
GetServerLocalTimeResponse 
GetGameTypesResponse 
PublicMessageEvent 
PrivateMessageEvent 
SessionIdleEvent 
JoinRoomEvent 
JoinZoneEvent 
UserUpdateEvent 
ZoneUpdateEvent 
LeaveRoomEvent 
LeaveZoneEvent 
RoomVariableUpdateEvent 
UpdateRoomDetailsEvent 
BuddyStatusUpdatedEvent 
UserEvictedFromRoomEvent 
UserVariableUpdateEvent 
PluginMessageEvent 
AggregatePluginMessageEvent 
RegistryConnectToPreferredGatewayRequest 
DisconnectedEvent 
GatewayStartupExceptionsMessage 
RegistryLoginResponse 
RegistryConnectionResponse 
GatewayKickUserRequest 
ServerKickUserEvent 
UdpBackchannelEvent 
Unknown 
RtmpPlayVideo 
RtmpEventResponse 
RtmpRecordVideo 
RtmpPublishVideo 
RtmpUnpublishVideo 
RtmpAppendVideo 
RtmpStreamingStart 
RtmpStreamingStop 
DHInitiate 
DHPublicNumbers 
DHSharedModulusRequest 
DHSharedModulusResponse 
EncryptionStateChange 
ConnectionAttemptResponse 
ConnectionClosedEvent 
RegisterUDPConnectionRequest 
RegisterUDPConnectionResponse 
RemoveUDPConnectionRequest 
RemoveUDPConnectionResponse 
PingRequest 
PingResponse 
IdleTimeoutWarningEvent 
MarkGatewayClientLoggedInMessage 
Enumerator
BinaryTCP 
RTMP 
BinaryHTTP 
TextTCP 
BinaryUDP 
Enumerator
VariableCreated 
VariableUpdated 
VariableDeleted 
Enumerator
NOOP 
RUNNING 
PAUSED 
STOPPED 
Enumerator
AddUser 
DeleteUser 
OperatorGranted 
OperatorRevoked 
SendingVideoStream 
StoppingVideoStream 
Enumerator
VariableCreated 
VariableUpdated 
VariableDeleted 
Enumerator
AddRoom 
DeleteRoom 
UpdateRoom