No Description

EMGroup.h 3.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. /*!
  2. * \~chinese
  3. * @header EMGroup.h
  4. * @abstract 群组
  5. * @author Hyphenate
  6. * @version 3.00
  7. *
  8. * \~english
  9. * @header EMGroup.h
  10. * @abstract Group
  11. * @author Hyphenate
  12. * @version 3.00
  13. */
  14. #import <Foundation/Foundation.h>
  15. #import "EMGroupOptions.h"
  16. /*!
  17. * \~chinese
  18. * 群组
  19. *
  20. * \~english
  21. * Group
  22. */
  23. @interface EMGroup : NSObject
  24. /*!
  25. * \~chinese
  26. * 群组ID
  27. *
  28. * \~english
  29. * Group id
  30. */
  31. @property (nonatomic, copy, readonly) NSString *groupId;
  32. /*!
  33. * \~chinese
  34. * 群组的主题,需要获取群详情
  35. *
  36. * \~english
  37. * Subject of the group
  38. */
  39. @property (nonatomic, copy, readonly) NSString *subject;
  40. /*!
  41. * \~chinese
  42. * 群组的描述,需要获取群详情
  43. *
  44. * \~english
  45. * Description of the group
  46. */
  47. @property (nonatomic, copy, readonly) NSString *description;
  48. /*!
  49. * \~chinese
  50. * 群组当前的成员数量,需要获取群详情
  51. *
  52. * \~english
  53. * The total number of group members
  54. */
  55. @property (nonatomic, readonly) NSInteger occupantsCount __deprecated_msg("Use - membersCount");
  56. @property (nonatomic, readonly) NSInteger membersCount;
  57. /*!
  58. * \~chinese
  59. * 群组属性配置,需要获取群详情
  60. *
  61. * \~english
  62. * Setting options of group
  63. */
  64. @property (nonatomic, strong, readonly) EMGroupOptions *setting;
  65. /*!
  66. * \~chinese
  67. * 群组的所有者,拥有群的最高权限,需要获取群详情
  68. *
  69. * 群组的所有者只有一人
  70. *
  71. * \~english
  72. * Owner of the group
  73. *
  74. * Each group only has one owner
  75. */
  76. @property (nonatomic, copy, readonly) NSString *owner;
  77. /*!
  78. * \~chinese
  79. * 群组的成员列表,需要获取群详情
  80. *
  81. * \~english
  82. * Member list of the group
  83. */
  84. @property (nonatomic, copy, readonly) NSArray *members;
  85. /*!
  86. * \~chinese
  87. * 群组的黑名单,需要先调用获取群黑名单方法
  88. *
  89. * 需要owner权限才能查看,非owner返回nil
  90. *
  91. * \~english
  92. * Group‘s blacklist of blocked users
  93. *
  94. * Need owner's authority to access, return nil if user is not the group owner.
  95. */
  96. @property (nonatomic, strong, readonly) NSArray *bans __deprecated_msg("Use - blackList");
  97. @property (nonatomic, strong, readonly) NSArray *blackList;
  98. /*!
  99. * \~chinese
  100. * 群组的所有成员(包含owner和members)
  101. *
  102. * \~english
  103. * All occupants of the group, includes the group owner and all other group members
  104. */
  105. @property (nonatomic, strong, readonly) NSArray *occupants;
  106. /*!
  107. * \~chinese
  108. * 此群组是否接收消息推送通知
  109. *
  110. * \~english
  111. * Is Apple Push Notification Service enabled for group
  112. */
  113. @property (nonatomic, readonly) BOOL isPushNotificationEnabled;
  114. /*!
  115. * \~chinese
  116. * 此群是否为公开群,需要获取群详情
  117. *
  118. * \~english
  119. * Whether is a public group
  120. */
  121. @property (nonatomic, readonly) BOOL isPublic;
  122. /*!
  123. * \~chinese
  124. * 是否屏蔽群消息
  125. *
  126. * \~english
  127. * Whether block the current group‘s messages
  128. */
  129. @property (nonatomic, readonly) BOOL isBlocked;
  130. /*!
  131. * \~chinese
  132. * 初始化群组实例
  133. *
  134. * 请使用+groupWithId:方法
  135. *
  136. * @result nil
  137. *
  138. * \~english
  139. * Initialize a group instance
  140. *
  141. * Please use [+groupWithId:]
  142. *
  143. * @result nil
  144. */
  145. - (instancetype)init __deprecated_msg("Use +groupWithId:");
  146. /*!
  147. * \~chinese
  148. * 获取群组实例,如果不存在则创建
  149. *
  150. * @param aGroupId 群组ID
  151. *
  152. * @result 群组实例
  153. *
  154. * \~english
  155. * Get group instance, create a instance if it does not exist
  156. *
  157. * @param aGroupId Group id
  158. *
  159. * @result Group instance
  160. */
  161. + (instancetype)groupWithId:(NSString *)aGroupId;
  162. @end