ChatDisconnectCause.cs 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. // ----------------------------------------------------------------------------------------------------------------------
  2. // <summary>The Photon Chat Api enables clients to connect to a chat server and communicate with other clients.</summary>
  3. // <remarks>ChatClient is the main class of this api.</remarks>
  4. // <copyright company="Exit Games GmbH">Photon Chat Api - Copyright (C) 2014 Exit Games GmbH</copyright>
  5. // ----------------------------------------------------------------------------------------------------------------------
  6. namespace Photon.Chat
  7. {
  8. /// <summary>Enumeration of causes for Disconnects (used in <see cref="ChatClient.DisconnectedCause"/>).</summary>
  9. /// <remarks>Read the individual descriptions to find out what to do about this type of disconnect.</remarks>
  10. public enum ChatDisconnectCause
  11. {
  12. /// <summary>No error was tracked.</summary>
  13. None,
  14. /// <summary>OnStatusChanged: The server is not available or the address is wrong. Make sure the port is provided and the server is up.</summary>
  15. ExceptionOnConnect,
  16. /// <summary>OnStatusChanged: The server disconnected this client from within the room's logic (the C# code).</summary>
  17. DisconnectByServerLogic,
  18. /// <summary>OnStatusChanged: The server disconnected this client for unknown reasons.</summary>
  19. DisconnectByServerReasonUnknown,
  20. /// <summary>OnStatusChanged: The server disconnected this client due to timing out (missing acknowledgement from the client).</summary>
  21. ServerTimeout,
  22. /// <summary>OnStatusChanged: This client detected that the server's responses are not received in due time.</summary>
  23. ClientTimeout,
  24. /// <summary>OnStatusChanged: Some internal exception caused the socket code to fail. Contact Exit Games.</summary>
  25. Exception,
  26. /// <summary>OnOperationResponse: Authenticate in the Photon Cloud with invalid AppId. Update your subscription or contact Exit Games.</summary>
  27. InvalidAuthentication,
  28. /// <summary>OnOperationResponse: Authenticate (temporarily) failed when using a Photon Cloud subscription without CCU Burst. Update your subscription.</summary>
  29. MaxCcuReached,
  30. /// <summary>OnOperationResponse: Authenticate when the app's Photon Cloud subscription is locked to some (other) region(s). Update your subscription or change region.</summary>
  31. InvalidRegion,
  32. /// <summary>OnOperationResponse: Operation that's (currently) not available for this client (not authorized usually). Only tracked for op Authenticate.</summary>
  33. OperationNotAllowedInCurrentState,
  34. /// <summary>OnOperationResponse: Authenticate in the Photon Cloud with invalid client values or custom authentication setup in Cloud Dashboard.</summary>
  35. CustomAuthenticationFailed,
  36. /// <summary>The authentication ticket should provide access to any Photon Cloud server without doing another authentication-service call. However, the ticket expired.</summary>
  37. AuthenticationTicketExpired,
  38. /// <summary>OnStatusChanged: The client disconnected from within the logic (the C# code).</summary>
  39. DisconnectByClientLogic
  40. }
  41. }