EMChatManagerDelegate.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. /*!
  2. * \~chinese
  3. * @header EMChatManagerDelegate.h
  4. * @abstract 此协议定义了聊天相关的回调
  5. * @author Hyphenate
  6. * @version 3.00
  7. *
  8. * \~english
  9. * @header EMChatManagerDelegate.h
  10. * @abstract This protocol defines chat related callbacks
  11. * @author Hyphenate
  12. * @version 3.00
  13. */
  14. #import <Foundation/Foundation.h>
  15. @class EMMessage;
  16. @class EMError;
  17. /*!
  18. * \~chinese
  19. * 聊天相关回调
  20. *
  21. * \~english
  22. * Chat related callbacks
  23. */
  24. @protocol EMChatManagerDelegate <NSObject>
  25. @optional
  26. #pragma mark - Conversation
  27. /*!
  28. * \~chinese
  29. * 会话列表发生变化
  30. *
  31. * @param aConversationList 会话列表<EMConversation>
  32. *
  33. * \~english
  34. * Delegate method will be invoked when the conversation list has changed
  35. *
  36. * @param aConversationList Conversation list<EMConversation>
  37. */
  38. - (void)conversationListDidUpdate:(NSArray *)aConversationList;
  39. #pragma mark - Message
  40. /*!
  41. * \~chinese
  42. * 收到消息
  43. *
  44. * @param aMessages 消息列表<EMMessage>
  45. *
  46. * \~english
  47. * Invoked when receiving new messages
  48. *
  49. * @param aMessages Receivecd message list<EMMessage>
  50. */
  51. - (void)messagesDidReceive:(NSArray *)aMessages;
  52. /*!
  53. * \~chinese
  54. * 收到Cmd消息
  55. *
  56. * @param aCmdMessages Cmd消息列表<EMMessage>
  57. *
  58. * \~english
  59. * Invoked when receiving command messages
  60. *
  61. * @param aCmdMessages Command message list<EMMessage>
  62. */
  63. - (void)cmdMessagesDidReceive:(NSArray *)aCmdMessages;
  64. /*!
  65. * \~chinese
  66. * 收到已读回执
  67. *
  68. * @param aMessages 已读消息列表<EMMessage>
  69. *
  70. * \~english
  71. * Invoked when receiving read acknowledgement in message list
  72. *
  73. * @param aMessages Acknowledged message list<EMMessage>
  74. */
  75. - (void)messagesDidRead:(NSArray *)aMessages;
  76. /*!
  77. * \~chinese
  78. * 收到群消息已读回执
  79. *
  80. * @param aMessages 已读消息列表<EMGroupMessageAck>
  81. *
  82. * \~english
  83. * Invoked when receiving read acknowledgement in message list
  84. *
  85. * @param aMessages Acknowledged message list<EMGroupMessageAck>
  86. */
  87. - (void)groupMessageDidRead:(EMMessage *)aMessage
  88. groupAcks:(NSArray *)aGroupAcks;
  89. /*!
  90. * \~chinese
  91. * 所有群已读消息发生变化
  92. *
  93. * \~english
  94. * All group read messages count have changed
  95. *
  96. */
  97. - (void)groupMessageAckHasChanged;
  98. /*!
  99. * \~chinese
  100. * 收到消息送达回执
  101. *
  102. * @param aMessages 送达消息列表<EMMessage>
  103. *
  104. * \~english
  105. * Invoked when receiving delivered acknowledgement in message list
  106. *
  107. * @param aMessages Acknowledged message list<EMMessage>
  108. */
  109. - (void)messagesDidDeliver:(NSArray *)aMessages;
  110. /*!
  111. * \~chinese
  112. * 收到消息撤回
  113. *
  114. * @param aMessages 撤回消息列表<EMMessage>
  115. *
  116. * \~english
  117. * Delegate method will be invoked when receiving recall for message list
  118. *
  119. * @param aMessages Recall message list<EMMessage>
  120. */
  121. - (void)messagesDidRecall:(NSArray *)aMessages;
  122. /*!
  123. * \~chinese
  124. * 消息状态发生变化
  125. *
  126. * @param aMessage 状态发生变化的消息
  127. * @param aError 出错信息
  128. *
  129. * \~english
  130. * Invoked when message status has changed
  131. *
  132. * @param aMessage Message whose status has changed
  133. * @param aError Error info
  134. */
  135. - (void)messageStatusDidChange:(EMMessage *)aMessage
  136. error:(EMError *)aError;
  137. /*!
  138. * \~chinese
  139. * 消息附件状态发生改变
  140. *
  141. * @param aMessage 附件状态发生变化的消息
  142. * @param aError 错误信息
  143. *
  144. * \~english
  145. * Invoked when message attachment status has changed
  146. *
  147. * @param aMessage Message attachment status has changed
  148. * @param aError Error
  149. */
  150. - (void)messageAttachmentStatusDidChange:(EMMessage *)aMessage
  151. error:(EMError *)aError;
  152. #pragma mark - Deprecated methods
  153. /*!
  154. * \~chinese
  155. * 会话列表发生变化
  156. *
  157. * @param aConversationList 会话列表<EMConversation>
  158. *
  159. * \~english
  160. * The conversation list has changed
  161. *
  162. * @param aConversationList Conversation list<EMConversation>
  163. */
  164. - (void)didUpdateConversationList:(NSArray *)aConversationList __deprecated_msg("Use -conversationListDidUpdate:");
  165. /*!
  166. * \~chinese
  167. * 收到消息
  168. *
  169. * @param aMessages 消息列表<EMMessage>
  170. *
  171. * \~english
  172. * Received messages
  173. *
  174. * @param aMessages Message list<EMMessage>
  175. */
  176. - (void)didReceiveMessages:(NSArray *)aMessages __deprecated_msg("Use -messagesDidReceive:");
  177. /*!
  178. * \~chinese
  179. * 收到Cmd消息
  180. *
  181. * @param aCmdMessages Cmd消息列表<EMMessage>
  182. *
  183. * \~english
  184. * Received cmd messages
  185. *
  186. * @param aCmdMessages Cmd message list<EMMessage>
  187. */
  188. - (void)didReceiveCmdMessages:(NSArray *)aCmdMessages __deprecated_msg("Use -cmdMessagesDidReceive:");
  189. /*!
  190. * \~chinese
  191. * 收到已读回执
  192. *
  193. * @param aMessages 已读消息列表<EMMessage>
  194. *
  195. * \~english
  196. * Received read acks
  197. *
  198. * @param aMessages Read acked message list<EMMessage>
  199. */
  200. - (void)didReceiveHasReadAcks:(NSArray *)aMessages __deprecated_msg("Use -messagesDidRead:");
  201. /*!
  202. * \~chinese
  203. * 收到消息送达回执
  204. *
  205. * @param aMessages 送达消息列表<EMMessage>
  206. *
  207. * \~english
  208. * Received deliver acks
  209. *
  210. * @param aMessages Deliver acked message list<EMMessage>
  211. */
  212. - (void)didReceiveHasDeliveredAcks:(NSArray *)aMessages __deprecated_msg("Use -messagesDidDeliver:");
  213. /*!
  214. * \~chinese
  215. * 消息状态发生变化
  216. *
  217. * @param aMessage 状态发生变化的消息
  218. * @param aError 出错信息
  219. *
  220. * \~english
  221. * Message status has changed
  222. *
  223. * @param aMessage Message whose status changed
  224. * @param aError Error info
  225. */
  226. - (void)didMessageStatusChanged:(EMMessage *)aMessage
  227. error:(EMError *)aError __deprecated_msg("Use -messageStatusDidChange:error");
  228. /*!
  229. * \~chinese
  230. * 消息附件状态发生改变
  231. *
  232. * @param aMessage 附件状态发生变化的消息
  233. * @param aError 错误信息
  234. *
  235. * \~english
  236. * Attachment status has changed
  237. *
  238. * @param aMessage Message whose attachment status changed
  239. * @param aError Error
  240. */
  241. - (void)didMessageAttachmentsStatusChanged:(EMMessage *)aMessage
  242. error:(EMError *)aError __deprecated_msg("Use -messageAttachmentStatusDidChange:error");
  243. @end