HyphenateChatSDK  4.19.0
IEMChatManager.h
1 
15 #import <Foundation/Foundation.h>
16 
17 #import "EMCommonDefs.h"
18 #import "EMChatManagerDelegate.h"
19 #import "EMConversation.h"
20 
21 #import "EMChatMessage.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 "EMCombineMessageBody.h"
31 #import "EMCursorResult.h"
32 
33 #import "EMGroupMessageAck.h"
34 #import "EMTranslateLanguage.h"
35 #import "EMVoiceParam.h"
36 #import "EMFetchServerMessagesOption.h"
37 #import "EMConversationFilter.h"
38 
46 typedef NS_ENUM(NSUInteger, EMMessageFetchHistoryDirection) {
47  EMMessageFetchHistoryDirectionUp = 0,
48  EMMessageFetchHistoryDirectionDown
50 };
51 
52 
53 @class EMError;
54 
66 @protocol IEMChatManager <NSObject>
67 
68 @required
69 
70 #pragma mark - Delegate
71 
85 - (void)addDelegate:(id<EMChatManagerDelegate> _Nullable)aDelegate
86  delegateQueue:(dispatch_queue_t _Nullable)aQueue;
87 
99 - (void)removeDelegate:(id<EMChatManagerDelegate> _Nonnull)aDelegate;
100 
101 #pragma mark - Conversation
102 
118 - (NSArray<EMConversation *> * _Nullable)getAllConversations;
119 
145 - (NSArray<EMConversation *> * _Nullable)filterConversationsFromDB:(BOOL)cleanMemoryCache filter:(BOOL(^_Nullable)(EMConversation * _Nonnull conversation))filter NS_SWIFT_NAME(filterConversationsFromDB(cleanMemoryCache:filter:));
146 
147 
156 
178 - (NSArray<EMConversation *> * _Nullable)getAllConversations:(BOOL)isSort;
179 
191 - (void)getConversationsFromServer:(void (^_Nullable)(NSArray<EMConversation *> * _Nullable aConversations, EMError * _Nullable aError))aCompletionBlock EM_DEPRECATED_IOS(4_0_0, "Use -IEMChatManager getConversationsFromServerWithCursor:pageSize:completion");
192 
208 - (void)getConversationsFromServerByPage:(NSUInteger)pageNumber
209  pageSize:(NSUInteger)pageSize
210  completion:(void (^_Nullable)(NSArray<EMConversation *> * _Nullable aConversations, EMError * _Nullable aError))aCompletionBlock EM_DEPRECATED_IOS(4_0_0, "Use -IEMChatManager getConversationsFromServerWithCursor:pageSize:completion");
234 - (void)getConversationsFromServerWithCursor:(nullable NSString *)cursor pageSize:(UInt8)pageSize completion:(nonnull void (^)(EMCursorResult<EMConversation *> * _Nullable result, EMError * _Nullable error))completionBlock;
235 
255 - (void)getPinnedConversationsFromServerWithCursor:(nullable NSString *)cursor pageSize:(UInt8)limit completion:(nonnull void (^)(EMCursorResult<EMConversation *> * _Nullable result, EMError * _Nullable error))completionBlock;
256 
276 - (void)pinConversation:(nonnull NSString *)conversationId isPinned:(BOOL)isPinned completionBlock:(nullable void(^)(EMError * _Nullable error))completionBlock;
277 
293 - (EMConversation *_Nullable)getConversationWithConvId:(NSString * _Nullable)aConversationId;
294 
318 - (EMConversation *_Nullable)getConversation:(NSString *_Nonnull)aConversationId
319  type:(EMConversationType)aType
320  createIfNotExist:(BOOL)aIfCreate;
321 
349 - (EMConversation *_Nullable)getConversation:(NSString *_Nonnull)aConversationId
350  type:(EMConversationType)aType
351  createIfNotExist:(BOOL)aIfCreate isThread:(BOOL)isThread;
352 
373 - (void)deleteConversation:(NSString * _Nonnull)aConversationId
374  isDeleteMessages:(BOOL)aIsDeleteMessages
375  completion:(void (^_Nullable)(NSString * _Nullable aConversationId, EMError *_Nullable aError))aCompletionBlock;
376 
399  - (void)deleteServerConversation:(NSString * _Nonnull)aConversationId
400  conversationType:(EMConversationType)aConversationType
401  isDeleteServerMessages:(BOOL)aIsDeleteServerMessages
402  completion:(void (^_Nullable)(NSString * _Nullable aConversationId, EMError * _Nullable aError))aCompletionBlock;
403 
424 - (void)deleteConversations:(NSArray<EMConversation *> * _Nullable)aConversations
425  isDeleteMessages:(BOOL)aIsDeleteMessages
426  completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
427 
443 - (void)importConversations:(NSArray<EMConversation *> * _Nullable)aConversations
444  completion:(void (^ _Nullable)(EMError * _Nullable aError))aCompletionBlock;
445 
446 #pragma mark - Message
447 
462 - (EMChatMessage * _Nullable)getMessageWithMessageId:(NSString * _Nonnull)aMessageId;
463 
483 - (NSString * _Nullable)getMessageAttachmentPath:(NSString * _Nonnull)aConversationId;
484 
499 - (void)importMessages:(NSArray<EMChatMessage *> * _Nonnull)aMessages
500  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
501 
522 - (void)updateMessage:(EMChatMessage *_Nonnull)aMessage
523  completion:(void (^_Nullable)(EMChatMessage * _Nullable aMessage, EMError * _Nullable aError))aCompletionBlock;
543 - (void)modifyMessage:(NSString *_Nonnull)messageId body:(EMMessageBody *_Nonnull)body completion:(void (^_Nonnull)(EMError * _Nullable error,EMChatMessage *_Nullable message))completionBlock;
544 
576 - (void)modifyMessage:(NSString *_Nonnull)messageId
577  body:(EMMessageBody *_Nullable)body
578  ext:(NSDictionary* _Nullable)ext
579  completion:(void (^_Nonnull)(EMError * _Nullable error,EMChatMessage *_Nullable message))completionBlock;
580 
601 - (void)sendMessageReadAck:(NSString * _Nonnull)aMessageId
602  toUser:(NSString * _Nonnull)aUsername
603  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
604 
605 
628 - (void)sendGroupMessageReadAck:(NSString * _Nonnull)aMessageId
629  toGroup:(NSString * _Nonnull)aGroupId
630  content:(NSString * _Nullable)aContent
631  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
632 
666 - (void)ackConversationRead:(NSString * _Nonnull)conversationId
667  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
668 
697 - (void)recallMessageWithMessageId:(NSString *_Nonnull)aMessageId
698  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
699 
720 - (void)recallMessageWithMessageId:(NSString *_Nonnull)aMessageId ext:(NSString * _Nullable)ext completion:(void (^_Nonnull)(EMError * _Nullable))aCompletionBlock;
740 - (void)sendMessage:(EMChatMessage *_Nonnull)aMessage
741  progress:(void (^_Nullable)(int progress))aProgressBlock
742  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
743 
759 - (void)resendMessage:(EMChatMessage *_Nonnull)aMessage
760  progress:(void (^_Nullable)(int progress))aProgressBlock
761  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
762 
782 - (void)downloadMessageThumbnail:(EMChatMessage *_Nonnull)aMessage
783  progress:(void (^_Nullable)(int progress))aProgressBlock
784  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
785 
809 - (void)downloadMessageAttachment:(EMChatMessage *_Nonnull)aMessage
810  progress:(void (^_Nullable)(int progress))aProgressBlock
811  completion:(void (^_Nullable)(EMChatMessage *_Nullable message, EMError *_Nullable error))aCompletionBlock;
812 
830 - (void)downloadAndParseCombineMessage:(EMChatMessage* _Nonnull)aMessage
831  completion:(void (^_Nullable)(NSArray<EMChatMessage *>*_Nullable messages, EMError *_Nullable error))aCompletionBlock;
832 
859 - (EMCursorResult<EMChatMessage*> *_Nullable)fetchHistoryMessagesFromServer:(NSString *_Nonnull)aConversationId
860  conversationType:(EMConversationType)aConversationType
861  startMessageId:(NSString *_Nullable)aStartMessageId
862  fetchDirection:(EMMessageFetchHistoryDirection)direction
863  pageSize:(int)aPageSize
864  error:(EMError **_Nullable)pError __deprecated_msg("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead");
889 - (EMCursorResult<EMChatMessage*> *_Nullable)fetchHistoryMessagesFromServer:(NSString *_Nonnull)aConversationId
890  conversationType:(EMConversationType)aConversationType
891  startMessageId:(NSString *_Nullable)aStartMessageId
892  pageSize:(int)aPageSize
893  error:(EMError **_Nullable)pError __deprecated_msg("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead");
894 
895 
920 - (void)asyncFetchHistoryMessagesFromServer:(NSString *_Nonnull)aConversationId
921  conversationType:(EMConversationType)aConversationType
922  startMessageId:(NSString *_Nullable)aStartMessageId
923  pageSize:(int)aPageSize
924  completion:(void (^_Nullable)(EMCursorResult<EMChatMessage*> *_Nullable aResult, EMError *_Nullable aError))aCompletionBlock __deprecated_msg("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead");
951 - (void)asyncFetchHistoryMessagesFromServer:(NSString *_Nonnull)aConversationId
952  conversationType:(EMConversationType)aConversationType
953  startMessageId:(NSString *_Nullable)aStartMessageId
954  fetchDirection:(EMMessageFetchHistoryDirection)direction
955  pageSize:(int)aPageSize
956  completion:(void (^_Nullable)(EMCursorResult<EMChatMessage*> *_Nullable aResult, EMError *_Nullable aError))aCompletionBlock __deprecated_msg("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead");
957 
958 
959 
960 
989 - (void)asyncFetchGroupMessageAcksFromServer:(NSString *_Nonnull)aMessageId
990  groupId:(NSString *_Nonnull)aGroupId
991  startGroupAckId:(NSString *_Nonnull)aGroupAckId
992  pageSize:(int)aPageSize
993  completion:(void (^_Nullable)(EMCursorResult<EMGroupMessageAck *> *_Nullable aResult, EMError *_Nullable error, int totalCount))aCompletionBlock;
994 
1018 - (void)reportMessageWithId:(NSString *_Nonnull )aMessageId
1019  tag:(NSString *_Nonnull)aTag
1020  reason:(NSString *_Nonnull)aReason
1021  completion:(void(^_Nullable)(EMError* _Nullable error))aCompletion;
1022 
1039 - (void)deleteMessagesBefore:(NSUInteger)aTimestamp
1040  completion:(void(^)(EMError*error))aCompletion;
1041 
1042 
1043 
1060 - (void)removeMessagesFromServerWithConversation:(EMConversation *_Nonnull)conversation messageIds:(NSArray <__kindof NSString*>*_Nonnull)messageIds completion:(void (^ _Nullable)(EMError * _Nullable aError))aCompletionBlock;
1077 - (void)removeMessagesFromServerWithConversation:(EMConversation *_Nonnull)conversation timeStamp:(NSTimeInterval)beforeTimeStamp completion:(void (^ _Nullable)(EMError * _Nullable aError))aCompletionBlock;
1078 
1079 
1095 - (void)translateMessage:(EMChatMessage * _Nonnull)aMessage
1096  targetLanguages:(NSArray<NSString*>* _Nonnull)aLanguages
1097  completion:(void (^_Nullable)(EMChatMessage * _Nullable message, EMError * _Nullable error))aCompletionBlock;
1098 
1124 - (void)voiceMessageToText:(EMChatMessage * _Nonnull)aMessage
1125  completion:(void (^_Nullable)(NSString * _Nullable text, EMError * _Nullable error))aCompletionBlock;
1126 
1150 - (void)voiceFileToText:(NSString * _Nonnull)aFilePath
1151  voiceParam:(EMVoiceParam * _Nullable)aVoiceParam
1152  completion:(void (^_Nullable)(NSString * _Nullable text, EMError * _Nullable error))aCompletionBlock;
1153 
1166 - (void)fetchSupportedLanguages:(void(^_Nullable)(NSArray<EMTranslateLanguage*>* _Nullable languages,EMError* _Nullable error))aCompletionBlock;
1167 
1204 - (NSArray<EMChatMessage *> * _Nullable)loadMessagesWithType:(EMMessageBodyType)aType
1205  timestamp:(long long)aTimestamp
1206  count:(int)aCount
1207  fromUser:(NSString* _Nullable)aUsername
1208  searchDirection:(EMMessageSearchDirection)aDirection;
1209 
1240 - (void)loadMessagesWithType:(EMMessageBodyType)aType
1241  timestamp:(long long)aTimestamp
1242  count:(int)aCount
1243  fromUser:(NSString*)aUsername
1244  searchDirection:(EMMessageSearchDirection)aDirection
1245  completion:(void (^)(NSArray<EMChatMessage *> *aMessages, EMError *aError))aCompletionBlock;
1246 
1247 
1278 - (void)searchMessagesWithTypes:(NSArray <NSNumber*>* _Nonnull)aTypes
1279  timestamp:(long long)aTimestamp
1280  count:(int)aCount
1281  fromUser:(NSString* _Nullable)aUsername
1282  searchDirection:(EMMessageSearchDirection)aDirection
1283  completion:(void (^_Nonnull)(NSArray<EMChatMessage *> * _Nullable aMessages, EMError * _Nullable aError))aCompletionBlock;
1284 
1321 - (NSArray<EMChatMessage *> *)loadMessagesWithKeyword:(NSString*)aKeywords
1322  timestamp:(long long)aTimestamp
1323  count:(int)aCount
1324  fromUser:(NSString*)aSender
1325  searchDirection:(EMMessageSearchDirection)aDirection;
1326 
1356 - (void)loadMessagesWithKeyword:(NSString*)aKeywords
1357  timestamp:(long long)aTimestamp
1358  count:(int)aCount
1359  fromUser:(NSString*)aSender
1360  searchDirection:(EMMessageSearchDirection)aDirection
1361  completion:(void (^)(NSArray<EMChatMessage *> *aMessages, EMError *aError))aCompletionBlock;
1362 
1394 - (void)loadMessagesWithKeyword:(NSString*)aKeywords
1395  timestamp:(long long)aTimestamp
1396  count:(int)aCount
1397  fromUser:(NSString*)aSender
1398  searchDirection:(EMMessageSearchDirection)aDirection
1399  scope:(EMMessageSearchScope)aScope
1400  completion:(void (^)(NSArray<EMChatMessage *> *aMessages, EMError *aError))aCompletionBlock;
1401 
1426 - (void)loadConversationMessagesWithKeyword:(NSString*_Nullable )aKeywords
1427  timestamp:(long long)aTimestamp
1428  fromUser:(NSString*_Nullable )aSender
1429  searchDirection:(EMMessageSearchDirection)aDirection
1430  scope:(EMMessageSearchScope)aScope
1431  completion:(void (^ _Nonnull)(NSDictionary<NSString*,NSArray<NSString*> *> * _Nullable aConversationMessages, EMError * _Nullable aError))aCompletionBlock;
1432 
1433 NS_ASSUME_NONNULL_BEGIN
1449 - (void)addReaction:(NSString *)reaction toMessage:(NSString *)messageId completion:(nullable void(^)(EMError * _Nullable))completion;
1450 
1466 - (void)removeReaction:(NSString *)reaction fromMessage:(NSString *)messageId completion:(nullable void(^)(EMError * _Nullable))completion;
1467 
1485 - (void)getReactionList:(NSArray <NSString *>*)messageIds
1486  groupId:(nullable NSString *)groupId
1487  chatType:(EMChatType)chatType
1488  completion:(void (^)(NSDictionary <NSString *, NSArray<EMMessageReaction *> *> *, EMError * _Nullable))completion;
1489 
1509 - (void)getReactionDetail:(NSString *)messageId
1510  reaction:(NSString *)reaction
1511  cursor:(nullable NSString *)cursor
1512  pageSize:(uint64_t)pageSize
1513  completion:(void (^)(EMMessageReaction *, NSString * _Nullable cursor, EMError * _Nullable))completion;
1514 
1545 - (void)fetchMessagesFromServerBy:(NSString* )conversationId
1546  conversationType:(EMConversationType)type
1547  cursor:(NSString* _Nullable)cursor
1548  pageSize:(NSUInteger)pageSize
1549  option:(EMFetchServerMessagesOption* _Nullable)option
1550  completion:(void (^_Nullable)(EMCursorResult<EMChatMessage*>* _Nullable result, EMError* _Nullable aError))aCompletionBlock;
1551 
1572 - (void)addConversationMark:(NSArray<NSString*>* _Nonnull)conversationIds mark:(EMMarkType)mark completion:(void (^_Nullable)(EMError* _Nullable aError))completion;
1573 
1595 - (void)removeConversationMark:(NSArray<NSString*>* _Nonnull)conversationIds mark:(EMMarkType)mark completion:(void (^_Nullable)(EMError* _Nullable aError))completion;
1596 
1613 - (void)getConversationsFromServerWithCursor:(NSString * _Nullable)cursor filter:(EMConversationFilter* _Nonnull)filter completion:(nonnull void (^)(EMCursorResult<EMConversation *> * _Nullable result, EMError * _Nullable error))completionBlock;
1614 
1637 - (void)deleteAllMessagesAndConversations:(BOOL)clearServerData completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
1638 
1652 - (void)pinMessage:(NSString* _Nonnull)messageId completion:(void (^_Nullable)(EMChatMessage* _Nullable message,EMError * _Nullable aError))aCompletionBlock;
1667 - (void)unpinMessage:(NSString* _Nonnull)messageId completion:(void (^_Nullable)(EMChatMessage* _Nullable message,EMError * _Nullable aError))aCompletionBlock;
1668 
1682 - (void)getPinnedMessagesFromServer:(NSString* _Nonnull)conversationId completion:(void (^_Nullable)(NSArray<EMChatMessage*>* _Nullable messages,EMError * _Nullable aError))aCompletionBlock;
1683 
1696 
1708 - (void)getMessageCountWithCompletion:(void (^)(NSInteger count, EMError * _Nullable aError))completion;
1709 
1723 - (void)getMessages:(NSArray<NSString *> * _Nonnull)aMessageIds
1724  withConversationId:(NSString * _Nonnull)aConversationId
1725  completion:(void (^ _Nonnull)(NSArray<EMChatMessage *> * _Nullable aMessages, EMError * _Nullable aError))aCompletionBlock;
1726 
1727 NS_ASSUME_NONNULL_END
1728 
1729 @end
EMError * markAllConversationsAsRead()
Definition: EMConversationFilter.h:21
Definition: EMChatManagerDelegate.h:31
Definition: EMConversation.h:114
Definition: EMError.h:26
Definition: EMMessageReaction.h:20
Definition: EMMessageBody.h:45
Definition: EMChatMessage.h:154
Definition: EMTranslateLanguage.h:19
void cleanConversationsMemoryCache()
Definition: EMGroupMessageAck.h:20
Definition: EMFetchServerMessagesOption.h:22
Definition: EMCursorResult.h:27
Definition: EMVoiceParam.h:38
Definition: IEMChatManager.h:66
NSArray< EMConversation * > *_Nullable getAllConversations()