AgoraChatConversation.h

 
#import <Foundation/Foundation.h>
 
#import "AgoraChatMessageBody.h"
#import "AgoraChatCursorResult.h"
#import "AgoraChatSilentModeParam.h"
 
typedef NS_ENUM(NSInteger, AgoraChatConversationType) {
    AgoraChatConversationTypeChat = 0,    
    AgoraChatConversationTypeGroupChat,    
    AgoraChatConversationTypeChatRoom,      
};
 
typedef NS_ENUM(NSInteger, AgoraChatMarkType) {
    AgoraChatMarkType0 = 0,
    AgoraChatMarkType1 = 1,
    AgoraChatMarkType2 = 2,
    AgoraChatMarkType3 = 3,
    AgoraChatMarkType4 = 4,
    AgoraChatMarkType5 = 5,
    AgoraChatMarkType6 = 6,
    AgoraChatMarkType7 = 7,
    AgoraChatMarkType8 = 8,
    AgoraChatMarkType9 = 9,
    AgoraChatMarkType10 = 10,
    AgoraChatMarkType11 = 11,
    AgoraChatMarkType12 = 12,
    AgoraChatMarkType13 = 13,
    AgoraChatMarkType14 = 14,
    AgoraChatMarkType15 = 15,
    AgoraChatMarkType16 = 16,
    AgoraChatMarkType17 = 17,
    AgoraChatMarkType18 = 18,
    AgoraChatMarkType19 = 19,
};
 
typedef NS_ENUM(NSInteger, AgoraChatMessageSearchDirection) {
    AgoraChatMessageSearchDirectionUp  = 0,    
    AgoraChatMessageSearchDirectionDown        
};
 
typedef NS_ENUM(NSInteger, AgoraChatMessageSearchScope) {
    AgoraChatMessageSearchScopeContent  = 0,   
    AgoraChatMessageSearchScopeExt,           
    AgoraChatMessageSearchScopeAll           
};
 
@class AgoraChatMessage;
@class AgoraChatError;
 
@interface AgoraChatConversation : NSObject
 
@property (nonatomic, copy, readonly) NSString *conversationId;
 
@property (nonatomic, assign, readonly) AgoraChatConversationType type;
 
@property (nonatomic, assign, readonly) int unreadMessagesCount;
 
@property (nonatomic, assign, readonly) int messagesCount;
 
@property (nonatomic, copy)   NSDictionary *ext;
 
@property (nonatomic, assign) BOOL isChatThread;
 
@property (readonly) BOOL isPinned;
 
@property (readonly) int64_t pinnedTime;
 
@property (nonatomic, strong, readonly) AgoraChatMessage *latestMessage;
 
@property (nonatomic, readonly) NSArray<NSNumber*>* marks;
 
@property (nonatomic, readonly) AgoraChatPushRemindType disturbType;
 
- (AgoraChatMessage * _Nullable)lastReceivedMessage;
 
- (void)insertMessage:(AgoraChatMessage *_Nonnull)aMessage
                error:(AgoraChatError ** _Nullable)pError;
 
- (void)appendMessage:(AgoraChatMessage *_Nonnull)aMessage
                error:(AgoraChatError **_Nullable)pError;
 
- (void)deleteMessageWithId:(NSString *_Nonnull)aMessageId
                      error:(AgoraChatError ** _Nullable)pError;
 
- (void)deleteAllMessages:(AgoraChatError ** _Nullable)pError;
 
 
- (void)removeMessagesFromServerMessageIds:(NSArray <__kindof NSString*>*_Nonnull)messageIds completion:(void (^ _Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;
- (void)removeMessagesFromServerWithTimeStamp:(NSTimeInterval)beforeTimeStamp completion:(void (^ _Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (void)updateMessageChange:(AgoraChatMessage *_Nonnull)aMessage
                      error:(AgoraChatError ** _Nullable)pError;
 
- (void)markMessageAsReadWithId:(NSString *_Nonnull)aMessageId
                          error:(AgoraChatError ** _Nullable)pError;
 
- (void)markAllMessagesAsRead:(AgoraChatError ** _Nullable)pError;
 
- (NSArray<AgoraChatMessage*>* _Nullable)pinnedMessages;
 
 
#pragma mark - Load Messages Methods
 
- (AgoraChatMessage * _Nullable)loadMessageWithId:(NSString * _Nonnull)aMessageId
                           error:(AgoraChatError ** _Nullable)pError;
 
- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesStartFromId:(NSString * _Nullable)aMessageId
                          count:(int)aCount
                searchDirection:(AgoraChatMessageSearchDirection)aDirection;
 
- (void)loadMessagesStartFromId:(NSString * _Nullable)aMessageId
                          count:(int)aCount
                searchDirection:(AgoraChatMessageSearchDirection)aDirection
                     completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesWithType:(AgoraChatMessageBodyType)aType
                                                   timestamp:(long long)aTimestamp
                                                       count:(int)aCount
                                                    fromUser:(NSString* _Nullable)aUsername
                                             searchDirection:(AgoraChatMessageSearchDirection)aDirection;
 
- (void)loadMessagesWithType:(AgoraChatMessageBodyType)aType
                   timestamp:(long long)aTimestamp
                       count:(int)aCount
                    fromUser:(NSString* _Nullable)aUsername
             searchDirection:(AgoraChatMessageSearchDirection)aDirection
                  completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
- (void)searchMessagesWithTypes:(NSArray <NSNumber*> *_Nonnull)aTypes
                   timestamp:(long long)aTimestamp
                       count:(int)aCount
                    fromUser:(NSString* _Nullable)aUsername
             searchDirection:(AgoraChatMessageSearchDirection)aDirection
                  completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesWithKeyword:(NSString* _Nullable)aKeyword
                      timestamp:(long long)aTimestamp
                          count:(int)aCount
                       fromUser:(NSString* _Nullable)aSender
                searchDirection:(AgoraChatMessageSearchDirection)aDirection;
 
- (void)loadMessagesWithKeyword:(NSString* _Nullable)aKeyword
                      timestamp:(long long)aTimestamp
                          count:(int)aCount
                       fromUser:(NSString* _Nullable)aSender
                searchDirection:(AgoraChatMessageSearchDirection)aDirection
                     completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (void)loadMessagesWithKeyword:(NSString* _Nullable)aKeyword
                      timestamp:(long long)aTimestamp
                          count:(int)aCount
                       fromUser:(NSString* _Nullable)aSender
                searchDirection:(AgoraChatMessageSearchDirection)aDirection
                          scope:(AgoraChatMessageSearchScope)aScope
                     completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (NSArray<AgoraChatMessage *> * _Nullable)loadCustomMsgWithKeyword:(NSString*)aKeyword
                       timestamp:(long long)aTimestamp
                           count:(int)aCount
                        fromUser:(NSString* _Nullable)aSender
                 searchDirection:(AgoraChatMessageSearchDirection)aDirection;
 
- (void)loadCustomMsgWithKeyword:(NSString* _Nullable)aKeyword
                       timestamp:(long long)aTimestamp
                           count:(int)aCount
                        fromUser:(NSString* _Nullable)aSender
                 searchDirection:(AgoraChatMessageSearchDirection)aDirection
                      completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesFrom:(long long)aStartTimestamp
                      to:(long long)aEndTimestamp
                   count:(int)aCount;
 
- (void)loadMessagesFrom:(long long)aStartTimestamp
                      to:(long long)aEndTimestamp
                   count:(int)aCount
              completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (AgoraChatError* _Nullable)removeMessagesStart:(NSInteger)aStartTimestamp
                                       to:(NSInteger)aEndTimestamp;
 
- (NSInteger)getMessageCountStart:(NSInteger)aStartTimestamp
                               to:(NSInteger)aEndTimestamp;
@end