Photon Server API Documentation v5.0RC1

Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
Photon.Common.Authentication.AuthenticationToken Class Reference
Inheritance diagram for Photon.Common.Authentication.AuthenticationToken:
Photon.SocketServer.Rpc.DataContract

Public Member Functions

 AuthenticationToken ()
 
virtual bool AreEqual (AuthenticationToken rhs)
 
virtual byte[] Serialize ()
 
- 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...
 

Static Public Member Functions

static bool TryDeserialize (byte[] data, out AuthenticationToken token, out string errorMsg)
 

Protected Member Functions

 AuthenticationToken (IRpcProtocol protocol, IDictionary< byte, object > dataMembers)
 
- 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...
 

Properties

byte Version [get]
 
DateTime ExpireAt [get]
 
DateTime FinalExpireAt [get]
 
bool IsFinalExpireAtUsed [get]
 
long ExpireAtTicks [get, set]
 
string ApplicationId [get, set]
 
string ApplicationVersion [get, set]
 
string UserId [get, set]
 
Dictionary< string, object > AuthCookie [get, set]
 
string SessionId [get, set]
 
int Flags [get, set]
 
Dictionary< byte, object > EncryptionData [get, set]
 
long FinalExpireAtTicks [get, set]
 When this point in time reached we do not extend token validity time More...
 
string TokenIssuer [get, set]
 
byte? CustomAuthProvider [get, set]
 what custom auth provider was used for this client if any More...
 
bool NoTokenAuthOnMaster [get, set]
 
string ExpectedGS [get, set]
 
string ExpectedGameId [get, set]
 
bool CustomAuthUserIdUsed [get, set]
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from Photon.SocketServer.Rpc.DataContract
string errorMessage
 The error message. More...
 
bool isValid
 The is valid. More...
 

Constructor & Destructor Documentation

◆ AuthenticationToken() [1/2]

Photon.Common.Authentication.AuthenticationToken.AuthenticationToken ( IRpcProtocol  protocol,
IDictionary< byte, object >  dataMembers 
)
inlineprotected

◆ AuthenticationToken() [2/2]

Photon.Common.Authentication.AuthenticationToken.AuthenticationToken ( )
inline

Member Function Documentation

◆ AreEqual()

virtual bool Photon.Common.Authentication.AuthenticationToken.AreEqual ( AuthenticationToken  rhs)
inlinevirtual

◆ Serialize()

virtual byte [] Photon.Common.Authentication.AuthenticationToken.Serialize ( )
inlinevirtual

◆ TryDeserialize()

static bool Photon.Common.Authentication.AuthenticationToken.TryDeserialize ( byte[]  data,
out AuthenticationToken  token,
out string  errorMsg 
)
inlinestatic

Property Documentation

◆ ApplicationId

string Photon.Common.Authentication.AuthenticationToken.ApplicationId
getset

◆ ApplicationVersion

string Photon.Common.Authentication.AuthenticationToken.ApplicationVersion
getset

◆ AuthCookie

Dictionary<string, object> Photon.Common.Authentication.AuthenticationToken.AuthCookie
getset

◆ CustomAuthProvider

byte? Photon.Common.Authentication.AuthenticationToken.CustomAuthProvider
getset

what custom auth provider was used for this client if any

◆ CustomAuthUserIdUsed

bool Photon.Common.Authentication.AuthenticationToken.CustomAuthUserIdUsed
getset

◆ EncryptionData

Dictionary<byte, object> Photon.Common.Authentication.AuthenticationToken.EncryptionData
getset

◆ ExpectedGameId

string Photon.Common.Authentication.AuthenticationToken.ExpectedGameId
getset

◆ ExpectedGS

string Photon.Common.Authentication.AuthenticationToken.ExpectedGS
getset

◆ ExpireAt

DateTime Photon.Common.Authentication.AuthenticationToken.ExpireAt
get

◆ ExpireAtTicks

long Photon.Common.Authentication.AuthenticationToken.ExpireAtTicks
getset

◆ FinalExpireAt

DateTime Photon.Common.Authentication.AuthenticationToken.FinalExpireAt
get

◆ FinalExpireAtTicks

long Photon.Common.Authentication.AuthenticationToken.FinalExpireAtTicks
getset

When this point in time reached we do not extend token validity time

◆ Flags

int Photon.Common.Authentication.AuthenticationToken.Flags
getset

◆ IsFinalExpireAtUsed

bool Photon.Common.Authentication.AuthenticationToken.IsFinalExpireAtUsed
get

◆ NoTokenAuthOnMaster

bool Photon.Common.Authentication.AuthenticationToken.NoTokenAuthOnMaster
getset

◆ SessionId

string Photon.Common.Authentication.AuthenticationToken.SessionId
getset

◆ TokenIssuer

string Photon.Common.Authentication.AuthenticationToken.TokenIssuer
getset

◆ UserId

string Photon.Common.Authentication.AuthenticationToken.UserId
getset

◆ Version

byte Photon.Common.Authentication.AuthenticationToken.Version
get