即时通讯 IM iOS API 参考

1

16

18

26typedef NS_ENUM(NSInteger, AgoraChatConversationType) {

27 AgoraChatConversationTypeChat = 0,

28 AgoraChatConversationTypeGroupChat,

29 AgoraChatConversationTypeChatRoom,

30};

31

39typedef NS_ENUM(NSInteger, AgoraChatMessageSearchDirection) {

40 AgoraChatMessageSearchDirectionUp = 0,

41 AgoraChatMessageSearchDirectionDown

42};

43

44@class AgoraChatMessage;

45@class AgoraChatError;

46

54@interface AgoraChatConversation : NSObject

55

71@property (nonatomic, copy, readonly) NSString *conversationId;

72

80@property (nonatomic, assign, readonly) AgoraChatConversationType type;

81

89@property (nonatomic, assign, readonly) int unreadMessagesCount;

90

98@property (nonatomic, assign, readonly) int messagesCount;

99

107@property (nonatomic, copy) NSDictionary *ext;

108

116@property (nonatomic, assign) BOOL isChatThread;

117

125@property (nonatomic, strong, readonly) AgoraChatMessage *latestMessage;

126

138- (AgoraChatMessage * _Nullable)lastReceivedMessage;

139

161- (void)insertMessage:(AgoraChatMessage *_Nonnull)aMessage

162 error:(AgoraChatError ** _Nullable)pError;

163

178- (void)appendMessage:(AgoraChatMessage *_Nonnull)aMessage

179 error:(AgoraChatError **_Nullable)pError;

180

195- (void)deleteMessageWithId:(NSString *_Nonnull)aMessageId

196 error:(AgoraChatError ** _Nullable)pError;

197

209- (void)deleteAllMessages:(AgoraChatError ** _Nullable)pError;

210

211

224- (void)removeMessagesFromServerMessageIds:(NSArray <__kindof NSString*>*_Nonnull)messageIds completion:(void (^ _Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;

238- (void)removeMessagesFromServerWithTimeStamp:(NSTimeInterval)beforeTimeStamp completion:(void (^ _Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;

239

258- (void)updateMessageChange:(AgoraChatMessage *_Nonnull)aMessage

259 error:(AgoraChatError ** _Nullable)pError;

260

275- (void)markMessageAsReadWithId:(NSString *_Nonnull)aMessageId

276 error:(AgoraChatError ** _Nullable)pError;

277

290- (void)markAllMessagesAsRead:(AgoraChatError ** _Nullable)pError;

291

292

294

309- (AgoraChatMessage * _Nullable)loadMessageWithId:(NSString * _Nonnull)aMessageId

310 error:(AgoraChatError ** _Nullable)pError;

311

342- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesStartFromId:(NSString * _Nullable)aMessageId

343 count:(int)aCount

344 searchDirection:(AgoraChatMessageSearchDirection)aDirection;

345

370- (void)loadMessagesStartFromId:(NSString * _Nullable)aMessageId

371 count:(int)aCount

372 searchDirection:(AgoraChatMessageSearchDirection)aDirection

373 completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;

374

407- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesWithType:(AgoraChatMessageBodyType)aType

408 timestamp:(long long)aTimestamp

409 count:(int)aCount

410 fromUser:(NSString* _Nullable)aUsername

411 searchDirection:(AgoraChatMessageSearchDirection)aDirection;

412

437- (void)loadMessagesWithType:(AgoraChatMessageBodyType)aType

438 timestamp:(long long)aTimestamp

439 count:(int)aCount

440 fromUser:(NSString* _Nullable)aUsername

441 searchDirection:(AgoraChatMessageSearchDirection)aDirection

442 completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;

443

474- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesWithKeyword:(NSString* _Nullable)aKeyword

475 timestamp:(long long)aTimestamp

476 count:(int)aCount

477 fromUser:(NSString* _Nullable)aSender

478 searchDirection:(AgoraChatMessageSearchDirection)aDirection;

479

504- (void)loadMessagesWithKeyword:(NSString* _Nullable)aKeyword

505 timestamp:(long long)aTimestamp

506 count:(int)aCount

507 fromUser:(NSString* _Nullable)aSender

508 searchDirection:(AgoraChatMessageSearchDirection)aDirection

509 completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;

510

542- (NSArray<AgoraChatMessage *> * _Nullable)loadCustomMsgWithKeyword:(NSString*)aKeyword

543 timestamp:(long long)aTimestamp

544 count:(int)aCount

545 fromUser:(NSString* _Nullable)aSender

546 searchDirection:(AgoraChatMessageSearchDirection)aDirection;

547

572- (void)loadCustomMsgWithKeyword:(NSString* _Nullable)aKeyword

573 timestamp:(long long)aTimestamp

574 count:(int)aCount

575 fromUser:(NSString* _Nullable)aSender

576 searchDirection:(AgoraChatMessageSearchDirection)aDirection

577 completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;

578

606- (NSArray<AgoraChatMessage *> * _Nullable)loadMessagesFrom:(long long)aStartTimestamp

607 to:(long long)aEndTimestamp

608 count:(int)aCount;

609

628- (void)loadMessagesFrom:(long long)aStartTimestamp

629 to:(long long)aEndTimestamp

630 count:(int)aCount

631 completion:(void (^ _Nullable)(NSArray<AgoraChatMessage *> * _Nullable aMessages, AgoraChatError * _Nullable aError))aCompletionBlock;

632