ChatUserStatus.cs 2.0 KB

1234567891011121314151617181920212223242526272829303132333435
  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>Contains commonly used status values for SetOnlineStatus. You can define your own.</summary>
  9. /// <remarks>
  10. /// While "online" (value 2 and up), the status message will be sent to anyone who has you on his friend list.
  11. ///
  12. /// Define custom online status values as you like with these rules:
  13. /// 0: Means "offline". It will be used when you are not connected. In this status, there is no status message.
  14. /// 1: Means "invisible" and is sent to friends as "offline". They see status 0, no message but you can chat.
  15. /// 2: And any higher value will be treated as "online". Status can be set.
  16. /// </remarks>
  17. public static class ChatUserStatus
  18. {
  19. /// <summary>(0) Offline.</summary>
  20. public const int Offline = 0;
  21. /// <summary>(1) Be invisible to everyone. Sends no message.</summary>
  22. public const int Invisible = 1;
  23. /// <summary>(2) Online and available.</summary>
  24. public const int Online = 2;
  25. /// <summary>(3) Online but not available.</summary>
  26. public const int Away = 3;
  27. /// <summary>(4) Do not disturb.</summary>
  28. public const int DND = 4;
  29. /// <summary>(5) Looking For Game/Group. Could be used when you want to be invited or do matchmaking.</summary>
  30. public const int LFG = 5;
  31. /// <summary>(6) Could be used when in a room, playing.</summary>
  32. public const int Playing = 6;
  33. }
  34. }