Classes | |
class | AuthenticationValues |
Container for user authentication in Photon. Set AuthValues before you connect - all else is handled. More... | |
class | ChannelCreationOptions |
class | ChannelWellKnownProperties |
class | ChatAppSettings |
Settings for Photon application(s) and the server to connect to. More... | |
class | ChatChannel |
A channel of communication in Photon Chat, updated by ChatClient and provided as READ ONLY. More... | |
class | ChatClient |
Central class of the Photon Chat API to connect, handle channels and messages. More... | |
class | ChatEventCode |
Wraps up internally used constants in Photon Chat events. You don't have to use them directly usually. More... | |
class | ChatOperationCode |
Wraps up codes for operations used internally in Photon Chat. You don't have to use them directly usually. More... | |
class | ChatParameterCode |
Wraps up codes for parameters (in operations and events) used internally in Photon Chat. You don't have to use them directly usually. More... | |
class | ChatPeer |
Provides basic operations of the Photon Chat server. This internal class is used by public ChatClient. More... | |
class | ChatUserStatus |
Contains commonly used status values for SetOnlineStatus. You can define your own. More... | |
class | ErrorCode |
ErrorCode defines the default codes associated with Photon client/server communication. More... | |
interface | IChatClientListener |
Callback interface for Chat client side. Contains callback methods to notify your app about updates. Must be provided to new ChatClient in constructor More... | |
class | ParameterCode |
Class for constants. Codes for parameters of Operations and Events. More... | |
Enumerations | |
enum | ChatDisconnectCause |
Enumeration of causes for Disconnects (used in ChatClient.DisconnectedCause). More... | |
enum | CustomAuthenticationType : byte |
Options for optional "Custom Authentication" services used with Photon. Used by OpAuthenticate after connecting to Photon. More... | |
enum | ChatState |
Possible states for a Chat Client. More... | |
|
strong |
Enumeration of causes for Disconnects (used in ChatClient.DisconnectedCause).
Read the individual descriptions to find out what to do about this type of disconnect.
Enumerator | |
---|---|
None | No error was tracked. |
ExceptionOnConnect | OnStatusChanged: The server is not available or the address is wrong. Make sure the port is provided and the server is up. |
DisconnectByServerLogic | OnStatusChanged: The server disconnected this client from within the room's logic (the C# code). |
DisconnectByServerReasonUnknown | OnStatusChanged: The server disconnected this client for unknown reasons. |
ServerTimeout | OnStatusChanged: The server disconnected this client due to timing out (missing acknowledgement from the client). |
ClientTimeout | OnStatusChanged: This client detected that the server's responses are not received in due time. |
Exception | OnStatusChanged: Some internal exception caused the socket code to fail. Contact Exit Games. |
InvalidAuthentication | OnOperationResponse: Authenticate in the Photon Cloud with invalid AppId. Update your subscription or contact Exit Games. |
MaxCcuReached | OnOperationResponse: Authenticate (temporarily) failed when using a Photon Cloud subscription without CCU Burst. Update your subscription. |
InvalidRegion | OnOperationResponse: Authenticate when the app's Photon Cloud subscription is locked to some (other) region(s). Update your subscription or change region. |
OperationNotAllowedInCurrentState | OnOperationResponse: Operation that's (currently) not available for this client (not authorized usually). Only tracked for op Authenticate. |
CustomAuthenticationFailed | OnOperationResponse: Authenticate in the Photon Cloud with invalid client values or custom authentication setup in Cloud Dashboard. |
AuthenticationTicketExpired | The authentication ticket should provide access to any Photon Cloud server without doing another authentication-service call. However, the ticket expired. |
DisconnectByClientLogic | OnStatusChanged: The client disconnected from within the logic (the C# code). |
|
strong |
Possible states for a Chat Client.
|
strong |
Options for optional "Custom Authentication" services used with Photon. Used by OpAuthenticate after connecting to Photon.
Enumerator | |
---|---|
Custom | Use a custom authentication service. Currently the only implemented option. |
Steam | Authenticates users by their Steam Account. Set Steam's ticket as "ticket" via AddAuthParameter(). |
Authenticates users by their Facebook Account. Set Facebooks's tocken as "token" via AddAuthParameter(). | |
Oculus | Authenticates users by their Oculus Account and token. Set Oculus' userid as "userid" and nonce as "nonce" via AddAuthParameter(). |
PlayStation4 | Authenticates users by their PSN Account and token on PS4. Set token as "token", env as "env" and userName as "userName" via AddAuthParameter(). |
Xbox | Authenticates users by their Xbox Account. Pass the XSTS token via SetAuthPostData(). |
Viveport | Authenticates users by their HTC Viveport Account. Set userToken as "userToken" via AddAuthParameter(). |
NintendoSwitch | Authenticates users by their NSA ID. Set token as "token" and appversion as "appversion" via AddAuthParameter(). The appversion is optional. |
PlayStation5 | Authenticates users by their PSN Account and token on PS5. Set token as "token", env as "env" and userName as "userName" via AddAuthParameter(). |
Epic | Authenticates users with Epic Online Services (EOS). Set token as "token" and ownershipToken as "ownershipToken" via AddAuthParameter(). The ownershipToken is optional. |
FacebookGaming | Authenticates users with Facebook Gaming api. Set token as "token" via AddAuthParameter(). |
None | Disables custom authentication. Same as not providing any AuthenticationValues for connect (more precisely for: OpAuthenticate). |