HyphenateChatSDK  3.8.7
IEMChatManager.h
1 
15 #import <Foundation/Foundation.h>
16 
17 #import "EMCommonDefs.h"
18 #import "EMChatManagerDelegate.h"
19 #import "EMConversation.h"
20 
21 #import "EMMessage.h"
22 #import "EMTextMessageBody.h"
23 #import "EMLocationMessageBody.h"
24 #import "EMCmdMessageBody.h"
25 #import "EMFileMessageBody.h"
26 #import "EMImageMessageBody.h"
27 #import "EMVoiceMessageBody.h"
28 #import "EMVideoMessageBody.h"
29 #import "EMCustomMessageBody.h"
30 #import "EMCursorResult.h"
31 
32 #import "EMGroupMessageAck.h"
33 
34 @class EMError;
35 
45 @protocol IEMChatManager <NSObject>
46 
47 @required
48 
49 #pragma mark - Delegate
50 
64 - (void)addDelegate:(id<EMChatManagerDelegate>)aDelegate
65  delegateQueue:(dispatch_queue_t)aQueue;
66 
78 - (void)removeDelegate:(id<EMChatManagerDelegate>)aDelegate;
79 
80 #pragma mark - Conversation
81 
93 - (NSArray *)getAllConversations;
94 
103 - (void)getConversationsFromServer:(void (^)(NSArray *aCoversations, EMError *aError))aCompletionBlock;
104 
120 - (EMConversation *)getConversationWithConvId:(NSString *)aConversationId;
121 
141 - (EMConversation *)getConversation:(NSString *)aConversationId
142  type:(EMConversationType)aType
143  createIfNotExist:(BOOL)aIfCreate;
144 
161 - (void)deleteConversation:(NSString *)aConversationId
162  isDeleteMessages:(BOOL)aIsDeleteMessages
163  completion:(void (^)(NSString *aConversationId, EMError *aError))aCompletionBlock;
164 
181 - (void)deleteConversations:(NSArray *)aConversations
182  isDeleteMessages:(BOOL)aIsDeleteMessages
183  completion:(void (^)(EMError *aError))aCompletionBlock;
184 
200 - (void)importConversations:(NSArray *)aConversations
201  completion:(void (^)(EMError *aError))aCompletionBlock;
202 
203 #pragma mark - Message
204 
218 - (EMMessage *)getMessageWithMessageId:(NSString *)aMessageId;
219 
235 - (NSString *)getMessageAttachmentPath:(NSString *)aConversationId;
236 
251 - (void)importMessages:(NSArray *)aMessages
252  completion:(void (^)(EMError *aError))aCompletionBlock;
253 
268 - (void)updateMessage:(EMMessage *)aMessage
269  completion:(void (^)(EMMessage *aMessage, EMError *aError))aCompletionBlock;
270 
289 - (void)sendMessageReadAck:(NSString *)aMessageId
290  toUser:(NSString *)aUsername
291  completion:(void (^)(EMError *aError))aCompletionBlock;
292 
293 
314 - (void)sendGroupMessageReadAck:(NSString *)aMessageId
315  toGroup:(NSString *)aGroupId
316  content:(NSString *)aContent
317  completion:(void (^)(EMError *aError))aCompletionBlock;
318 
343 - (void)ackConversationRead:(NSString *)conversationId
344  completion:(void (^)(EMError *aError))aCompletionBlock;
345 
363 - (void)recallMessageWithMessageId:(NSString *)aMessageId
364  completion:(void (^)(EMError *aError))aCompletionBlock;
365 
366 
382 - (void)sendMessage:(EMMessage *)aMessage
383  progress:(void (^)(int progress))aProgressBlock
384  completion:(void (^)(EMMessage *message, EMError *error))aCompletionBlock;
385 
401 - (void)resendMessage:(EMMessage *)aMessage
402  progress:(void (^)(int progress))aProgressBlock
403  completion:(void (^)(EMMessage *message, EMError *error))aCompletionBlock;
404 
421 - (void)downloadMessageThumbnail:(EMMessage *)aMessage
422  progress:(void (^)(int progress))aProgressBlock
423  completion:(void (^)(EMMessage *message, EMError *error))aCompletionBlock;
424 
442 - (void)downloadMessageAttachment:(EMMessage *)aMessage
443  progress:(void (^)(int progress))aProgressBlock
444  completion:(void (^)(EMMessage *message, EMError *error))aCompletionBlock;
445 
446 
447 
472 - (EMCursorResult *)fetchHistoryMessagesFromServer:(NSString *)aConversationId
473  conversationType:(EMConversationType)aConversationType
474  startMessageId:(NSString *)aStartMessageId
475  pageSize:(int)aPageSize
476  error:(EMError **)pError;
477 
478 
501 - (void)asyncFetchHistoryMessagesFromServer:(NSString *)aConversationId
502  conversationType:(EMConversationType)aConversationType
503  startMessageId:(NSString *)aStartMessageId
504  pageSize:(int)aPageSize
505  completion:(void (^)(EMCursorResult *aResult, EMError *aError))aCompletionBlock;
506 
507 
530 - (void)asyncFetchGroupMessageAcksFromServer:(NSString *)aMessageId
531  groupId:(NSString *)aGroupId
532  startGroupAckId:(NSString *)aGroupAckId
533  pageSize:(int)aPageSize
534  completion:(void (^)(EMCursorResult *aResult, EMError *error, int totalCount))aCompletionBlock;
535 
536 #pragma mark - EM_DEPRECATED_IOS 3.6.1
537 
554 - (void)sendMessageReadAck:(EMMessage *)aMessage
555  completion:(void (^)(EMMessage *aMessage, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_3_0, 3_6_1, "Use -[IEMChatManager sendMessageReadAck:toUser:completion:] instead");
556 
557 
575 - (void)recallMessage:(EMMessage *)aMessage
576  completion:(void (^)(EMMessage *aMessage, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_3_0, 3_6_1, "Use -[IEMChatManager recallMessageWithMessageId:completion:] instead");
577 
578 
579 #pragma mark - EM_DEPRECATED_IOS 3.2.3
580 
592 - (void)addDelegate:(id<EMChatManagerDelegate>)aDelegate EM_DEPRECATED_IOS(3_1_0, 3_2_2, "Use -[IEMChatManager addDelegate:delegateQueue:] instead");
593 
594 #pragma mark - EM_DEPRECATED_IOS < 3.2.3
595 
611 - (NSArray *)loadAllConversationsFromDB __deprecated_msg("Use -getAllConversations instead");
612 
630 - (BOOL)deleteConversation:(NSString *)aConversationId
631  deleteMessages:(BOOL)aDeleteMessage __deprecated_msg("Use -deleteConversation:isDeleteMessages:completion: instead");
632 
650 - (BOOL)deleteConversations:(NSArray *)aConversations
651  deleteMessages:(BOOL)aDeleteMessage __deprecated_msg("Use -deleteConversations:isDeleteMessages:completion: instead");
652 
668 - (BOOL)importConversations:(NSArray *)aConversations __deprecated_msg("Use -importConversations:completion: instead");
669 
685 - (BOOL)importMessages:(NSArray *)aMessages __deprecated_msg("Use -importMessages:completion: instead");
686 
702 - (BOOL)updateMessage:(EMMessage *)aMessage __deprecated_msg("Use -updateMessage:completion: instead");
703 
719 - (void)asyncSendReadAckForMessage:(EMMessage *)aMessage __deprecated_msg("Use -sendMessageReadAck:completion: instead");
720 
741 - (void)asyncSendMessage:(EMMessage *)aMessage
742  progress:(void (^)(int progress))aProgressCompletion
743  completion:(void (^)(EMMessage *message, EMError *error))aCompletion __deprecated_msg("Use -sendMessage:progress:completion: instead");
744 
764 - (void)asyncResendMessage:(EMMessage *)aMessage
765  progress:(void (^)(int progress))aProgressCompletion
766  completion:(void (^)(EMMessage *message, EMError *error))aCompletion __deprecated_msg("Use -resendMessage:progress:completion: instead");
767 
787 - (void)asyncDownloadMessageThumbnail:(EMMessage *)aMessage
788  progress:(void (^)(int progress))aProgressCompletion
789  completion:(void (^)(EMMessage * message, EMError *error))aCompletion __deprecated_msg("Use -downloadMessageThumbnail:progress:completion: instead");
790 
810 - (void)asyncDownloadMessageAttachments:(EMMessage *)aMessage
811  progress:(void (^)(int progress))aProgressCompletion
812  completion:(void (^)(EMMessage *message, EMError *error))aCompletion __deprecated_msg("Use -downloadMessageAttachment:progress:completion: instead");
813 
844 - (NSArray<EMMessage *> *)loadMessagesWithType:(EMMessageBodyType)aType
845  timestamp:(long long)aTimestamp
846  count:(int)aCount
847  fromUser:(NSString*)aUsername
848  searchDirection:(EMMessageSearchDirection)aDirection;
849 
874 - (void)loadMessagesWithType:(EMMessageBodyType)aType
875  timestamp:(long long)aTimestamp
876  count:(int)aCount
877  fromUser:(NSString*)aUsername
878  searchDirection:(EMMessageSearchDirection)aDirection
879  completion:(void (^)(NSArray *aMessages, EMError *aError))aCompletionBlock;
880 
911 - (NSArray<EMMessage *> *)loadMessagesWithKeyword:(NSString*)aKeywords
912  timestamp:(long long)aTimestamp
913  count:(int)aCount
914  fromUser:(NSString*)aSender
915  searchDirection:(EMMessageSearchDirection)aDirection;
916 
941 - (void)loadMessagesWithKeyword:(NSString*)aKeywords
942  timestamp:(long long)aTimestamp
943  count:(int)aCount
944  fromUser:(NSString*)aSender
945  searchDirection:(EMMessageSearchDirection)aDirection
946  completion:(void (^)(NSArray *aMessages, EMError *aError))aCompletionBlock;
947 
948 @end
Definition: EMConversation.h:55
Definition: EMCursorResult.h:25
Definition: EMError.h:27
Definition: EMMessage.h:66
Definition: EMChatManagerDelegate.h:27
Definition: IEMChatManager.h:45
"Use -getAllConversations instead" __deprecated_msg()
NSArray * getAllConversations()