HyphenateChatSDK  5.0.0
IEMChatManager.h
1 
15 #import <Foundation/Foundation.h>
16 
17 #import "EMCommonDefs.h"
18 #import "EMChatManagerDelegate.h"
19 #import "EMConversationDelegate.h"
20 #import "EMConversation.h"
21 
22 #import "EMChatMessage.h"
23 #import "EMTextMessageBody.h"
24 #import "EMLocationMessageBody.h"
25 #import "EMCmdMessageBody.h"
26 #import "EMFileMessageBody.h"
27 #import "EMImageMessageBody.h"
28 #import "EMVoiceMessageBody.h"
29 #import "EMVideoMessageBody.h"
30 #import "EMCustomMessageBody.h"
31 #import "EMCombineMessageBody.h"
32 #import "EMCursorResult.h"
33 #import "EMPageResult.h"
34 
35 #import "EMGroupReadReceipt.h"
36 #import "EMTranslateLanguage.h"
37 #import "EMVoiceParam.h"
38 #import "EMFetchServerMessagesOption.h"
39 #import "EMMessageSearchOption.h"
40 #import "EMSearchServerMessageResult.h"
41 #import "EMConversationFilter.h"
42 
50 typedef NS_ENUM(NSUInteger, EMMessageFetchHistoryDirection) {
51  EMMessageFetchHistoryDirectionUp = 0,
52  EMMessageFetchHistoryDirectionDown
54 };
55 
56 
57 @class EMError;
59 
71 @protocol IEMChatManager <NSObject>
72 
73 @required
74 
75 #pragma mark - Delegate
76 
90 - (void)addDelegate:(id<EMChatManagerDelegate> _Nullable)aDelegate
91  delegateQueue:(dispatch_queue_t _Nullable)aQueue;
92 
104 - (void)removeDelegate:(id<EMChatManagerDelegate> _Nonnull)aDelegate;
105 
119 - (void)addConversationDelegate:(id<EMConversationDelegate> _Nullable)aDelegate
120  delegateQueue:(dispatch_queue_t _Nullable)aQueue NS_SWIFT_NAME(addConversation(delegate:queue:));
121 
133 - (void)removeConversationDelegate:(id<EMConversationDelegate> _Nonnull)aDelegate NS_SWIFT_NAME(removeConversation(delegate:));
134 
135 #pragma mark - Conversation
136 
152 - (NSArray<EMConversation *> * _Nullable)getAllConversations;
153 
179 - (NSArray<EMConversation *> * _Nullable)filterConversationsFromDB:(BOOL)cleanMemoryCache filter:(BOOL(^_Nullable)(EMConversation * _Nonnull conversation))filter NS_SWIFT_NAME(filterConversationsFromDB(cleanMemoryCache:filter:));
180 
181 
190 
212 - (NSArray<EMConversation *> * _Nullable)getAllConversations:(BOOL)isSort;
213 
231 - (NSInteger)getUnreadMessageCount;
232 
256 - (void)getConversationsFromDBWithCursor:(nullable NSString *)cursor pageSize:(NSInteger)pageSize completion:(nonnull void (^)(EMCursorResult<EMConversation *> * _Nullable result, EMError * _Nullable error))completionBlock;
257 
277 - (void)pinConversation:(nonnull NSString *)conversationId isPinned:(BOOL)isPinned completionBlock:(nullable void(^)(EMError * _Nullable error))completionBlock;
278 
294 - (EMConversation *_Nullable)getConversationWithConvId:(NSString * _Nullable)aConversationId;
295 
319 - (EMConversation *_Nullable)getConversation:(NSString *_Nonnull)aConversationId
320  type:(EMConversationType)aType
321  createIfNotExist:(BOOL)aIfCreate;
322 
350 - (EMConversation *_Nullable)getConversation:(NSString *_Nonnull)aConversationId
351  type:(EMConversationType)aType
352  createIfNotExist:(BOOL)aIfCreate isThread:(BOOL)isThread;
353 
374 - (void)deleteConversation:(NSString * _Nonnull)aConversationId
375  isDeleteMessages:(BOOL)aIsDeleteMessages
376  completion:(void (^_Nullable)(NSString * _Nullable aConversationId, EMError *_Nullable aError))aCompletionBlock;
377 
400  - (void)deleteServerConversation:(NSString * _Nonnull)aConversationId
401  conversationType:(EMConversationType)aConversationType
402  isDeleteServerMessages:(BOOL)aIsDeleteServerMessages
403  completion:(void (^_Nullable)(NSString * _Nullable aConversationId, EMError * _Nullable aError))aCompletionBlock;
404 
425 - (void)deleteConversations:(NSArray<EMConversation *> * _Nullable)aConversations
426  isDeleteMessages:(BOOL)aIsDeleteMessages
427  completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
428 
429 #pragma mark - Message
430 
445 - (EMChatMessage * _Nullable)getMessageWithMessageId:(NSString * _Nonnull)aMessageId;
446 
466 - (NSString * _Nullable)getMessageAttachmentPath:(NSString * _Nonnull)aConversationId;
467 
482 - (void)importMessages:(NSArray<EMChatMessage *> * _Nonnull)aMessages
483  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
484 
505 - (void)updateMessage:(EMChatMessage *_Nonnull)aMessage
506  completion:(void (^_Nullable)(EMChatMessage * _Nullable aMessage, EMError * _Nullable aError))aCompletionBlock;
507 
539 - (void)modifyMessage:(NSString *_Nonnull)messageId
540  body:(EMMessageBody *_Nullable)body
541  ext:(NSDictionary* _Nullable)ext
542  completion:(void (^_Nonnull)(EMError * _Nullable error,EMChatMessage *_Nullable message))completionBlock;
543 
569 - (void)sendMessageReadReceipts:(NSArray<EMChatMessage *> * _Nonnull)aMessages
570  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
571 
594 - (void)clearConversationUnreadMessageCount:(NSString * _Nonnull)aConversationId
595  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
596 
616 - (void)clearAllConversationUnreadMessageCount:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
617 
631 - (void)getGroupMessageReadReceipts:(NSArray<EMChatMessage *> * _Nonnull)aMessages
632  completion:(void (^_Nullable)(NSArray<EMMessageReadReceipt *> *_Nullable aReceipts, EMError *_Nullable aError))aCompletionBlock;
633 
662 - (void)recallMessageWithMessageId:(NSString *_Nonnull)aMessageId
663  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
664 
685 - (void)recallMessageWithMessageId:(NSString *_Nonnull)aMessageId ext:(NSString * _Nullable)ext completion:(void (^_Nonnull)(EMError * _Nullable))aCompletionBlock;
709 - (void)sendMessage:(EMChatMessage *_Nonnull)aMessage
710  progress:(void (^_Nullable)(int progress))aProgressBlock
711  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
712 
752 - (void)downloadMessageThumbnail:(EMChatMessage *_Nonnull)aMessage
753  progress:(void (^_Nullable)(int progress))aProgressBlock
754  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
755 
803 - (void)downloadMessageAttachment:(EMChatMessage *_Nonnull)aMessage
804  progress:(void (^_Nullable)(int progress))aProgressBlock
805  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
847 - (void)downloadBigImageAttachment:(EMChatMessage *_Nonnull)aMessage
848  progress:(void (^_Nullable)(int progress))aProgressBlock
849  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
850 
868 - (void)downloadAndParseCombineMessage:(EMChatMessage* _Nonnull)aMessage
869  completion:(void (^_Nullable)(NSArray<EMChatMessage *>*_Nullable messages, EMError *_Nullable error))aCompletionBlock;
898 - (void)asyncFetchGroupMessageReadUsersFromServer:(NSString *_Nonnull)aMessageId
899  groupId:(NSString *_Nonnull)aGroupId
900  readReceiptId:(NSString *_Nonnull)aReadReceiptId
901  pageSize:(int)aPageSize
902  completion:(void (^_Nullable)(EMCursorResult<EMGroupReadReceipt *> *_Nullable aResult, EMError *_Nullable error, int totalCount))aCompletionBlock;
903 
920 - (void)deleteMessagesBefore:(NSUInteger)aTimestamp
921  completion:(void(^_Nullable)(EMError*_Nullable error))aCompletion;
922 
923 
924 
941 - (void)removeMessagesFromServerWithConversation:(EMConversation *_Nonnull)conversation messageIds:(NSArray <__kindof NSString*>*_Nonnull)messageIds completion:(void (^ _Nullable)(EMError * _Nullable aError))aCompletionBlock;
958 - (void)removeMessagesFromServerWithConversation:(EMConversation *_Nonnull)conversation timeStamp:(NSTimeInterval)beforeTimeStamp completion:(void (^ _Nullable)(EMError * _Nullable aError))aCompletionBlock;
959 
960 
976 - (void)translateMessage:(EMChatMessage * _Nonnull)aMessage
977  targetLanguages:(NSArray<NSString*>* _Nonnull)aLanguages
978  completion:(void (^_Nullable)(EMChatMessage * _Nullable message, EMError * _Nullable error))aCompletionBlock;
979 
1005 - (void)voiceMessageToText:(EMChatMessage * _Nonnull)aMessage
1006  completion:(void (^_Nullable)(NSString * _Nullable text, EMError * _Nullable error))aCompletionBlock;
1007 
1031 - (void)voiceFileToText:(NSString * _Nonnull)aFilePath
1032  voiceParam:(EMVoiceParam * _Nullable)aVoiceParam
1033  completion:(void (^_Nullable)(NSString * _Nullable text, EMError * _Nullable error))aCompletionBlock;
1034 
1047 - (void)fetchSupportedLanguages:(void(^_Nullable)(NSArray<EMTranslateLanguage*>* _Nullable languages,EMError* _Nullable error))aCompletionBlock;
1048 
1079 - (void)searchMessagesWithTypes:(NSArray <NSNumber*>* _Nonnull)aTypes
1080  timestamp:(long long)aTimestamp
1081  count:(int)aCount
1082  fromUser:(NSString* _Nullable)aUsername
1083  searchDirection:(EMMessageSearchDirection)aDirection
1084  completion:(void (^_Nonnull)(NSArray<EMChatMessage *> * _Nullable aMessages, EMError * _Nullable aError))aCompletionBlock;
1085 
1117 - (void)loadMessagesWithKeyword:(NSString* _Nonnull)aKeywords
1118  timestamp:(long long)aTimestamp
1119  count:(int)aCount
1120  fromUser:(NSString *_Nullable)aSender
1121  searchDirection:(EMMessageSearchDirection)aDirection
1122  scope:(EMMessageSearchScope)aScope
1123  completion:(void (^_Nullable)(NSArray<EMChatMessage *> *_Nullable aMessages, EMError *_Nullable aError))aCompletionBlock;
1124 
1149 - (void)loadConversationMessagesWithKeyword:(NSString*_Nullable )aKeywords
1150  timestamp:(long long)aTimestamp
1151  fromUser:(NSString*_Nullable )aSender
1152  searchDirection:(EMMessageSearchDirection)aDirection
1153  scope:(EMMessageSearchScope)aScope
1154  completion:(void (^ _Nonnull)(NSDictionary<NSString*,NSArray<NSString*> *> * _Nullable aConversationMessages, EMError * _Nullable aError))aCompletionBlock;
1155 
1156 NS_ASSUME_NONNULL_BEGIN
1172 - (void)addReaction:(NSString *)reaction toMessage:(NSString *)messageId completion:(nullable void(^)(EMError * _Nullable))completion;
1173 
1189 - (void)removeReaction:(NSString *)reaction fromMessage:(NSString *)messageId completion:(nullable void(^)(EMError * _Nullable))completion;
1190 
1208 - (void)getReactionList:(NSArray <NSString *>*)messageIds
1209  groupId:(nullable NSString *)groupId
1210  chatType:(EMChatType)chatType
1211  completion:(void (^)(NSDictionary <NSString *, NSArray<EMMessageReaction *> *> *, EMError * _Nullable))completion;
1212 
1232 - (void)getReactionDetail:(NSString *)messageId
1233  reaction:(NSString *)reaction
1234  cursor:(nullable NSString *)cursor
1235  pageSize:(uint64_t)pageSize
1236  completion:(void (^)(EMMessageReaction *, NSString * _Nullable cursor, EMError * _Nullable))completion;
1237 
1268 - (void)fetchMessagesFromServerBy:(NSString* )conversationId
1269  conversationType:(EMConversationType)type
1270  cursor:(NSString* _Nullable)cursor
1271  pageSize:(NSUInteger)pageSize
1272  option:(EMFetchServerMessagesOption* _Nullable)option
1273  completion:(void (^_Nullable)(EMCursorResult<EMChatMessage*>* _Nullable result, EMError* _Nullable aError))aCompletionBlock;
1274 
1295 - (void)searchMessagesFromServerWithOption:(EMMessageSearchOption *)option
1296  pageSize:(NSInteger)pageSize
1297  pageNum:(NSInteger)pageNum
1298  completion:(void (^_Nullable)(EMPageResult<EMSearchServerMessageResult*>* _Nullable result, EMError* _Nullable aError))completion;
1299 
1320 - (void)addConversationMark:(NSArray<NSString*>* _Nonnull)conversationIds mark:(EMMarkType)mark completion:(void (^_Nullable)(EMError* _Nullable aError))completion;
1321 
1343 - (void)removeConversationMark:(NSArray<NSString*>* _Nonnull)conversationIds mark:(EMMarkType)mark completion:(void (^_Nullable)(EMError* _Nullable aError))completion;
1344 
1345 
1368 - (void)deleteAllMessagesAndConversations:(BOOL)clearServerData completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
1369 
1383 - (void)pinMessage:(NSString* _Nonnull)messageId completion:(void (^_Nullable)(EMChatMessage* _Nullable message,EMError * _Nullable aError))aCompletionBlock;
1398 - (void)unpinMessage:(NSString* _Nonnull)messageId completion:(void (^_Nullable)(EMChatMessage* _Nullable message,EMError * _Nullable aError))aCompletionBlock;
1399 
1413 - (void)getPinnedMessagesFromServer:(NSString* _Nonnull)conversationId completion:(void (^_Nullable)(NSArray<EMChatMessage*>* _Nullable messages,EMError * _Nullable aError))aCompletionBlock;
1414 
1426 - (void)getMessageCountWithCompletion:(void (^)(NSInteger count, EMError * _Nullable aError))completion;
1427 
1441 - (void)getMessages:(NSArray<NSString *> * _Nonnull)aMessageIds
1442  withConversationId:(NSString * _Nonnull)aConversationId
1443  completion:(void (^ _Nonnull)(NSArray<EMChatMessage *> * _Nullable aMessages, EMError * _Nullable aError))aCompletionBlock;
1444 
1445 NS_ASSUME_NONNULL_END
1446 
1447 @end
Definition: EMChatManagerDelegate.h:31
Definition: EMMessageSearchOption.h:30
Definition: EMConversation.h:114
Definition: EMError.h:26
Definition: EMConversationDelegate.h:26
Definition: EMMessageReaction.h:20
Definition: EMMessageBody.h:56
Definition: EMChatMessage.h:154
Definition: EMTranslateLanguage.h:19
void cleanConversationsMemoryCache()
Definition: EMPageResult.h:24
Definition: EMMessageReadReceipt.h:17
Definition: EMGroupReadReceipt.h:21
Definition: EMFetchServerMessagesOption.h:22
NSInteger getUnreadMessageCount()
Definition: EMCursorResult.h:27
Definition: EMVoiceParam.h:38
Definition: EMSearchServerMessageResult.h:26
Definition: IEMChatManager.h:71
NSArray< EMConversation * > *_Nullable getAllConversations()