Photon Server API

Public Member Functions | Properties | List of all members
Photon.LoadBalancing.Operations.AuthenticateRequest Class Reference
Inheritance diagram for Photon.LoadBalancing.Operations.AuthenticateRequest:
Photon.SocketServer.Rpc.Operation Photon.Common.Authentication.IAuthenticateRequest Photon.SocketServer.Rpc.DataContract

Public Member Functions

 AuthenticateRequest (IRpcProtocol protocol, OperationRequest operationRequest)
 
 AuthenticateRequest ()
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
 Operation (IRpcProtocol protocol, OperationRequest request)
 Initializes a new instance of the Operation class. This contructor is used for incoming operations. More...
 
 Operation ()
 Initializes a new instance of the Operation class. This contructor is used for outgoing operations. More...
 
void OnComplete ()
 Updates photon counters for the measure execution time. Call OnStart first. More...
 
void OnStart ()
 Starts measuring the execution time. Call OnComplete to update photon counters. More...
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.DataContract
string GetErrorMessage ()
 Gets a message containing descriptive entries for each missing or invalid paramter. More...
 
Dictionary< byte, object > ToDictionary ()
 Converts all properties flagged with the DataMemberAttribute to a dictionary. More...
 

Properties

virtual string ApplicationId [get, set]
 
string ApplicationVersion [get, set]
 
string Token [get, set]
 
string UserId [get, set]
 
byte ClientAuthenticationType [get, set]
 
string ClientAuthenticationParams [get, set]
 
object ClientAuthenticationData [get, set]
 
bool ReceiveLobbyStatistics [get, set]
 Gets or sets a value indicating whether the client wants to receive lobby statistics. More...
 
virtual string Region [get, set]
 
int Flags [get, set]
 
bool IsTokenAuthUsed [get]
 
- Properties inherited from Photon.SocketServer.Rpc.Operation
OperationRequest OperationRequest [get]
 Gets the OperationRequest. More...
 
- Properties inherited from Photon.SocketServer.Rpc.DataContract
bool IsValid [get]
 Gets a value indicating whether all operation parameter are initialized. Call the GetErrorMessage method to get a detailed description for all missing parameters. More...
 
- Properties inherited from Photon.Common.Authentication.IAuthenticateRequest
string ApplicationId [get]
 
string ApplicationVersion [get]
 
string Token [get, set]
 
string UserId [get, set]
 
string Region [get, set]
 
byte ClientAuthenticationType [get]
 
string ClientAuthenticationParams [get]
 
object ClientAuthenticationData [get]
 
int Flags [get]
 

Additional Inherited Members

- Protected Member Functions inherited from Photon.SocketServer.Rpc.DataContract
 DataContract (IRpcProtocol protocol, IDictionary< byte, object > dataMembers)
 Initializes a new instance of the DataContract class. The params dictionary is mapped to properties flagged with the DataMemberAttribute. Check the IsValid property after creation to determine if all paramters have been initialized correctly. More...
 
 DataContract ()
 Initializes a new instance of the DataContract class. More...
 
- Protected Attributes inherited from Photon.SocketServer.Rpc.DataContract
string errorMessage
 The error message. More...
 
bool isValid
 The is valid. More...
 

Constructor & Destructor Documentation

◆ AuthenticateRequest() [1/2]

Photon.LoadBalancing.Operations.AuthenticateRequest.AuthenticateRequest ( IRpcProtocol  protocol,
OperationRequest  operationRequest 
)
inline

◆ AuthenticateRequest() [2/2]

Photon.LoadBalancing.Operations.AuthenticateRequest.AuthenticateRequest ( )
inline

Property Documentation

◆ ApplicationId

virtual string Photon.LoadBalancing.Operations.AuthenticateRequest.ApplicationId
getset

◆ ApplicationVersion

string Photon.LoadBalancing.Operations.AuthenticateRequest.ApplicationVersion
getset

◆ ClientAuthenticationData

object Photon.LoadBalancing.Operations.AuthenticateRequest.ClientAuthenticationData
getset

◆ ClientAuthenticationParams

string Photon.LoadBalancing.Operations.AuthenticateRequest.ClientAuthenticationParams
getset

◆ ClientAuthenticationType

byte Photon.LoadBalancing.Operations.AuthenticateRequest.ClientAuthenticationType
getset

◆ Flags

int Photon.LoadBalancing.Operations.AuthenticateRequest.Flags
getset

◆ IsTokenAuthUsed

bool Photon.LoadBalancing.Operations.AuthenticateRequest.IsTokenAuthUsed
get

◆ ReceiveLobbyStatistics

bool Photon.LoadBalancing.Operations.AuthenticateRequest.ReceiveLobbyStatistics
getset

Gets or sets a value indicating whether the client wants to receive lobby statistics.

◆ Region

virtual string Photon.LoadBalancing.Operations.AuthenticateRequest.Region
getset

◆ Token

string Photon.LoadBalancing.Operations.AuthenticateRequest.Token
getset

◆ UserId

string Photon.LoadBalancing.Operations.AuthenticateRequest.UserId
getset