Brak opisu

EMChatroom.h 2.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. /*!
  2. * \~chinese
  3. * @header EMChatroom.h
  4. * @abstract 聊天室
  5. * @author Hyphenate
  6. * @version 3.00
  7. *
  8. * \~english
  9. * @header EMChatroom.h
  10. * @abstract Chatroom
  11. * @author Hyphenate
  12. * @version 3.00
  13. */
  14. #import <Foundation/Foundation.h>
  15. /*!
  16. * \~chinese
  17. * 聊天室
  18. *
  19. * \~english
  20. * Chat room object
  21. */
  22. @interface EMChatroom : NSObject
  23. /*!
  24. * \~chinese
  25. * 聊天室ID
  26. *
  27. * \~english
  28. * Chat room id
  29. */
  30. @property (nonatomic, copy, readonly) NSString *chatroomId;
  31. /*!
  32. * \~chinese
  33. * 聊天室的主题
  34. *
  35. * \~english
  36. * Subject of chat room
  37. */
  38. @property (nonatomic, copy, readonly) NSString *subject;
  39. /*!
  40. * \~chinese
  41. * 聊天室的描述
  42. *
  43. * \~english
  44. * Description of chat room
  45. */
  46. @property (nonatomic, copy, readonly) NSString *description;
  47. /*!
  48. * \~chinese
  49. * 聊天室的所有者,需要获取聊天室详情
  50. *
  51. * 聊天室的所有者只有一人
  52. *
  53. * \~english
  54. * Owner of the chat room. Only one owner per chat room.
  55. */
  56. @property (nonatomic, copy, readonly) NSString *owner;
  57. /*!
  58. * \~chinese
  59. * 聊天室的当前人数,如果没有获取聊天室详情将返回0
  60. *
  61. * \~english
  62. * The total number of members in the chat room
  63. */
  64. @property (nonatomic, readonly) NSInteger occupantsCount __deprecated_msg("Use - membersCount");
  65. @property (nonatomic, readonly) NSInteger membersCount;
  66. /*!
  67. * \~chinese
  68. * 聊天室的最大人数,如果没有获取聊天室详情将返回0
  69. *
  70. * \~english
  71. * The capacity of the chat room
  72. */
  73. @property (nonatomic, readonly) NSInteger maxOccupantsCount __deprecated_msg("Use - maxMembersCount");
  74. @property (nonatomic, readonly) NSInteger maxMembersCount;
  75. /*!
  76. * \~chinese
  77. * 聊天室的成员列表,需要获取聊天室详情
  78. *
  79. * \~english
  80. * List of members in the chat room
  81. */
  82. @property (nonatomic, copy, readonly) NSArray *occupants __deprecated_msg("Use - members");
  83. @property (nonatomic, copy, readonly) NSArray *members;
  84. /*!
  85. * \~chinese
  86. * 初始化聊天室实例
  87. *
  88. * 请使用[+chatroomWithId:]方法
  89. *
  90. * @result nil
  91. *
  92. * \~english
  93. * Initialize chatroom instance
  94. *
  95. * Please use [+chatroomWithId:]
  96. *
  97. * @result nil
  98. */
  99. - (instancetype)init __deprecated_msg("Use +chatroomWithId:");
  100. /*!
  101. * \~chinese
  102. * 获取聊天室实例
  103. *
  104. * @param aChatroomId 聊天室ID
  105. *
  106. * @result 聊天室实例
  107. *
  108. * \~english
  109. * Construct a chatroom instance with chatroom id
  110. *
  111. * @param aChatroomId Chatroom id
  112. *
  113. * @result Chatroom instance
  114. */
  115. + (instancetype)chatroomWithId:(NSString *)aChatroomId;
  116. @end