Photon Server API

Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Photon.LoadBalancing.UnifiedClient.UnifiedTestClient Class Reference
Inheritance diagram for Photon.LoadBalancing.UnifiedClient.UnifiedTestClient:

Public Member Functions

 UnifiedTestClient (INUnitClient client, IAuthenticationScheme authScheme)
 
void CheckThereIsErrorInfoEvent (int timeout=3000)
 
void CheckThereIsNoErrorInfoEvent (int timeout=3000)
 
OperationResponse Authenticate (string userId, Dictionary< byte, object > authParameter)
 
GetLobbyStatsResponse GetLobbyStats (string[] lobbyNames, byte[] lobbyTypes, short expectedResult=ErrorCode.Ok)
 
CreateGameResponse CreateRoom (string roomName, RoomOptions roomOptions, TypedLobby lobby, Hashtable playerProperties, bool onGameServer, short expectedResult=ErrorCode.Ok)
 
CreateGameResponse CreateRoom (string roomName, RoomOptions roomOptions, TypedLobby lobby, Hashtable playerProperties, bool onGameServer, string pluginName, short expectedResult=ErrorCode.Ok)
 
CreateGameResponse CreateGame (string gameId, short expectedResult=ErrorCode.Ok)
 
CreateGameResponse CreateGame (string gameId, bool isVisible, bool isOpen, byte maxPlayer, short expectedResult=ErrorCode.Ok)
 
CreateGameResponse CreateGame (string gameId, bool isVisible, bool isOpen, byte maxPlayer, Hashtable gameProperties, string[] lobbyProperties, Hashtable playerProperties, short expectedResult=ErrorCode.Ok)
 
CreateGameResponse CreateGame (CreateGameRequest createGameRequest, short expectedResult=ErrorCode.Ok)
 
JoinGameResponse JoinRoom (string roomName, Hashtable playerProperties, int actorId, RoomOptions roomOptions, bool createIfNotExists, bool onGameServer, short errorCode=ErrorCode.Ok)
 
JoinGameResponse JoinGame (string gameId, short expectedResult=ErrorCode.Ok)
 
JoinGameResponse JoinGame (JoinGameRequest joinRequest, short expectedResult=ErrorCode.Ok)
 
JoinRandomGameResponse JoinRandomGame (Hashtable gameProperties, byte maxPlayers, Hashtable actorProperties, MatchmakingMode mode, string lobbyName, AppLobbyType lobbyType, string sqlLobbyFilter, short errorCode=ErrorCode.Ok)
 
JoinRandomGameResponse JoinRandomGame (JoinRandomGameRequest request, short expectedResult, params string[] expectedRoomNames)
 
OperationResponse JoinRandomGame (Hashtable gameProperties, string query, short expectedResult, string lobbyName=null, byte? lobbyType=null, params string[] expectedRoomNames)
 
OperationResponse LeaveGame (bool IsInActive=false)
 
OperationResponse JoinLobby (string lobbyName=null, byte? lobbyType=null, int maxGameCount=0, short expectedResult=0)
 
OperationResponse FindFriends (string[] userIds, out bool[] onlineStates, out string[] userStates)
 
virtual bool OpJoinLobby ()
 Calls OpJoinLobby(string name, LobbyType lobbyType). More...
 
virtual bool OpJoinLobby (string lobbyName, AppLobbyType lobbyType)
 Joins the lobby on the Master Server, where you get a list of RoomInfos of currently open rooms. This is an async request which triggers a OnOperationResponse() call. More...
 
virtual bool OpLeaveLobby ()
 
OperationResponse OpSetPropertiesOfRoom (Hashtable gameProperties)
 Sets properties of a room. Internally this uses OpSetProperties, which can be used to either set room or player properties. More...
 
OperationResponse OpSetPropertiesOfRoom (Hashtable gameProperties, bool webForward)
 Sets properties of a room. Internally this uses OpSetProperties, which can be used to either set room or player properties. More...
 
GetPropertiesResponse GetActorsProperties ()
 

Static Protected Member Functions

static void JoinRequestToDictionary (JoinGameRequest joinRequest, OperationRequest request)
 
static void RoomOptionsToOpParameters (JoinGameRequest request, RoomOptions roomOptions)
 
static OperationRequest CreateAuthenticateRequest (string userId)
 
static OperationRequest CreateFindfriendsRequest (string[] userIdList)
 
static CreateGameResponse GetCreateGameResponse (OperationResponse op)
 
static JoinGameResponse GetJoinGameResponse (OperationResponse op)
 
static GetLobbyStatsResponse GetLobbyStatsResponse (OperationResponse op)
 
static JoinRandomGameResponse GetJoinRandomGameResponse (OperationResponse op)
 
static GetPropertiesResponse CreateGetPropertiesResponse (OperationResponse response)
 
static bool TryGetParameter< T > (OperationResponse response, byte parameterCode, out T value)
 
static T GetParameter< T > (OperationResponse response, byte parameterCode, bool isOptional)
 

Protected Attributes

IAuthenticationScheme authenticationScheme
 

Constructor & Destructor Documentation

◆ UnifiedTestClient()

Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.UnifiedTestClient ( INUnitClient  client,
IAuthenticationScheme  authScheme 
)
inline

Member Function Documentation

◆ Authenticate()

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.Authenticate ( string  userId,
Dictionary< byte, object >  authParameter 
)
inline

◆ CheckThereIsErrorInfoEvent()

void Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CheckThereIsErrorInfoEvent ( int  timeout = 3000)
inline

◆ CheckThereIsNoErrorInfoEvent()

void Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CheckThereIsNoErrorInfoEvent ( int  timeout = 3000)
inline

◆ CreateAuthenticateRequest()

static OperationRequest Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateAuthenticateRequest ( string  userId)
inlinestaticprotected

◆ CreateFindfriendsRequest()

static OperationRequest Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateFindfriendsRequest ( string[]  userIdList)
inlinestaticprotected

◆ CreateGame() [1/4]

CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateGame ( CreateGameRequest  createGameRequest,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ CreateGame() [2/4]

CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateGame ( string  gameId,
bool  isVisible,
bool  isOpen,
byte  maxPlayer,
Hashtable  gameProperties,
string[]  lobbyProperties,
Hashtable  playerProperties,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ CreateGame() [3/4]

CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateGame ( string  gameId,
bool  isVisible,
bool  isOpen,
byte  maxPlayer,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ CreateGame() [4/4]

CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateGame ( string  gameId,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ CreateGetPropertiesResponse()

static GetPropertiesResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateGetPropertiesResponse ( OperationResponse  response)
inlinestaticprotected

◆ CreateRoom() [1/2]

CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateRoom ( string  roomName,
RoomOptions  roomOptions,
TypedLobby  lobby,
Hashtable  playerProperties,
bool  onGameServer,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ CreateRoom() [2/2]

CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.CreateRoom ( string  roomName,
RoomOptions  roomOptions,
TypedLobby  lobby,
Hashtable  playerProperties,
bool  onGameServer,
string  pluginName,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ FindFriends()

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.FindFriends ( string[]  userIds,
out bool[]  onlineStates,
out string[]  userStates 
)
inline

◆ GetActorsProperties()

GetPropertiesResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetActorsProperties ( )
inline

◆ GetCreateGameResponse()

static CreateGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetCreateGameResponse ( OperationResponse  op)
inlinestaticprotected

◆ GetJoinGameResponse()

static JoinGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetJoinGameResponse ( OperationResponse  op)
inlinestaticprotected

◆ GetJoinRandomGameResponse()

static JoinRandomGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetJoinRandomGameResponse ( OperationResponse  op)
inlinestaticprotected

◆ GetLobbyStats()

GetLobbyStatsResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetLobbyStats ( string[]  lobbyNames,
byte[]  lobbyTypes,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ GetLobbyStatsResponse()

static GetLobbyStatsResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetLobbyStatsResponse ( OperationResponse  op)
inlinestaticprotected

◆ GetParameter< T >()

static T Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.GetParameter< T > ( OperationResponse  response,
byte  parameterCode,
bool  isOptional 
)
inlinestaticprotected

◆ JoinGame() [1/2]

JoinGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinGame ( JoinGameRequest  joinRequest,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ JoinGame() [2/2]

JoinGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinGame ( string  gameId,
short  expectedResult = ErrorCode.Ok 
)
inline

◆ JoinLobby()

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinLobby ( string  lobbyName = null,
byte?  lobbyType = null,
int  maxGameCount = 0,
short  expectedResult = 0 
)
inline

◆ JoinRandomGame() [1/3]

JoinRandomGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinRandomGame ( Hashtable  gameProperties,
byte  maxPlayers,
Hashtable  actorProperties,
MatchmakingMode  mode,
string  lobbyName,
AppLobbyType  lobbyType,
string  sqlLobbyFilter,
short  errorCode = ErrorCode.Ok 
)
inline

◆ JoinRandomGame() [2/3]

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinRandomGame ( Hashtable  gameProperties,
string  query,
short  expectedResult,
string  lobbyName = null,
byte?  lobbyType = null,
params string[]  expectedRoomNames 
)
inline

◆ JoinRandomGame() [3/3]

JoinRandomGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinRandomGame ( JoinRandomGameRequest  request,
short  expectedResult,
params string[]  expectedRoomNames 
)
inline

◆ JoinRequestToDictionary()

static void Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinRequestToDictionary ( JoinGameRequest  joinRequest,
OperationRequest  request 
)
inlinestaticprotected

◆ JoinRoom()

JoinGameResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.JoinRoom ( string  roomName,
Hashtable  playerProperties,
int  actorId,
RoomOptions  roomOptions,
bool  createIfNotExists,
bool  onGameServer,
short  errorCode = ErrorCode.Ok 
)
inline

◆ LeaveGame()

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.LeaveGame ( bool  IsInActive = false)
inline

◆ OpJoinLobby() [1/2]

virtual bool Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.OpJoinLobby ( )
inlinevirtual

Calls OpJoinLobby(string name, LobbyType lobbyType).

Returns
If the operation could be sent (requires connection).

◆ OpJoinLobby() [2/2]

virtual bool Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.OpJoinLobby ( string  lobbyName,
AppLobbyType  lobbyType 
)
inlinevirtual

Joins the lobby on the Master Server, where you get a list of RoomInfos of currently open rooms. This is an async request which triggers a OnOperationResponse() call.

Parameters
lobbyNameThe lobby join to.
lobbyTypetype of lobby
Returns
If the operation could be sent (has to be connected).

◆ OpLeaveLobby()

virtual bool Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.OpLeaveLobby ( )
inlinevirtual

◆ OpSetPropertiesOfRoom() [1/2]

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.OpSetPropertiesOfRoom ( Hashtable  gameProperties)
inline

Sets properties of a room. Internally this uses OpSetProperties, which can be used to either set room or player properties.

Parameters
gameProperties
Returns
If the operation could be sent (has to be connected).

◆ OpSetPropertiesOfRoom() [2/2]

OperationResponse Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.OpSetPropertiesOfRoom ( Hashtable  gameProperties,
bool  webForward 
)
inline

Sets properties of a room. Internally this uses OpSetProperties, which can be used to either set room or player properties.

Parameters
gameProperties
webForward
Returns
If the operation could be sent (has to be connected).

◆ RoomOptionsToOpParameters()

static void Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.RoomOptionsToOpParameters ( JoinGameRequest  request,
RoomOptions  roomOptions 
)
inlinestaticprotected

◆ TryGetParameter< T >()

static bool Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.TryGetParameter< T > ( OperationResponse  response,
byte  parameterCode,
out T  value 
)
inlinestaticprotected

Member Data Documentation

◆ authenticationScheme

IAuthenticationScheme Photon.LoadBalancing.UnifiedClient.UnifiedTestClient.authenticationScheme
protected