#import <IAgoraChatManager.h>

Inheritance diagram for <IAgoraChatManager>:

Instance Methods
(void)	- addDelegate:delegateQueue:

(void)	- removeDelegate:

(NSArray< AgoraChatConversation * > *_Nullable)	- getAllConversations

(NSArray< AgoraChatConversation * > *_Nullable)	- filterConversationsFromDB:filter:

(void)	- cleanConversationsMemoryCache

(NSArray< AgoraChatConversation * > *_Nullable)	- getAllConversations:

(void)	- getConversationsFromServer:

(void)	- getConversationsFromServerByPage:pageSize:completion:

(void)	- getConversationsFromServerWithCursor:pageSize:completion:

(void)	- getPinnedConversationsFromServerWithCursor:pageSize:completion:

(void)	- pinConversation:isPinned:completionBlock:

(AgoraChatConversation *_Nullable)	- getConversationWithConvId:

(AgoraChatConversation *_Nullable)	- getConversation:type:createIfNotExist:

(AgoraChatConversation *_Nullable)	- getConversation:type:createIfNotExist:isThread:

(void)	- deleteConversation:isDeleteMessages:completion:

(void)	- deleteServerConversation:conversationType:isDeleteServerMessages:completion:

(void)	- deleteConversations:isDeleteMessages:completion:

(void)	- importConversations:completion:

(AgoraChatMessage *_Nullable)	- getMessageWithMessageId:

(NSString *_Nullable)	- getMessageAttachmentPath:

(void)	- importMessages:completion:

(void)	- updateMessage:completion:

(void)	- modifyMessage:body:completion:

(void)	- sendMessageReadAck:toUser:completion:

(void)	- sendGroupMessageReadAck:toGroup:content:completion:

(void)	- ackConversationRead:completion:

(void)	- recallMessageWithMessageId:completion:

(void)	- recallMessageWithMessageId:ext:completion:

(void)	- sendMessage:progress:completion:

(void)	- resendMessage:progress:completion:

(void)	- downloadMessageThumbnail:progress:completion:

(void)	- downloadMessageAttachment:progress:completion:

(void)	- downloadAndParseCombineMessage:completion:

(AgoraChatCursorResult< AgoraChatMessage * > *_Nullable)	- fetchHistoryMessagesFromServer:conversationType:startMessageId:fetchDirection:pageSize:error:

(AgoraChatCursorResult< AgoraChatMessage * > *_Nullable)	- fetchHistoryMessagesFromServer:conversationType:startMessageId:pageSize:error:

(void)	- asyncFetchHistoryMessagesFromServer:conversationType:startMessageId:pageSize:completion:

(void)	- asyncFetchHistoryMessagesFromServer:conversationType:startMessageId:fetchDirection:pageSize:completion:

(void)	- asyncFetchGroupMessageAcksFromServer:groupId:startGroupAckId:pageSize:completion:

(void)	- reportMessageWithId:tag:reason:completion:

(void)	- deleteMessagesBefore:completion:

(void)	- removeMessagesFromServerWithConversation:messageIds:completion:

(void)	- removeMessagesFromServerWithConversation:timeStamp:completion:

(void)	- translateMessage:targetLanguages:completion:

(void)	- fetchSupportedLanguages:

(NSArray< AgoraChatMessage * > *_Nullable)	- loadMessagesWithType:timestamp:count:fromUser:searchDirection:

(void)	- loadMessagesWithType:timestamp:count:fromUser:searchDirection:completion:

(void)	- searchMessagesWithTypes:timestamp:count:fromUser:searchDirection:completion:

(NSArray< AgoraChatMessage * > *)	- loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:

(void)	- loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:completion:

(void)	- loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:scope:completion:

(void)	- addReaction:toMessage:completion:

(void)	- removeReaction:fromMessage:completion:

(void)	- getReactionList:groupId:chatType:completion:

(void)	- getReactionDetail:reaction:cursor:pageSize:completion:

(void)	- fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion:

(void)	- addConversationMark:mark:completion:

(void)	- removeConversationMark:mark:completion:

(void)	- getConversationsFromServerWithCursor:filter:completion:

(void)	- deleteAllMessagesAndConversations:completion:

(void)	- pinMessage:completion:

(void)	- unpinMessage:completion:

(void)	- getPinnedMessagesFromServer:completion:

(AgoraChatError *)	- markAllConversationsAsRead

(void)	- getMessageCountWithCompletion:

Detailed Description

This protocol that defines the operations of chat.

Messages are loaded from the local database, not from the server.

Method Documentation

◆ ackConversationRead:completion:

- (void) ackConversationRead:	(NSString *_Nonnull)	conversationId
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Sends the conversation read receipt to the server.

This method applies to one-to-one chats only.

This method call notifies the server to set the number of unread messages of the specified conversation as 0, and triggers the onConversationRead callback on the recipient's client.

To reduce the number of method calls, we recommend that you call this method when the user enters a conversation with many unread messages, and call sendMessageReadAck during a conversation to send the message read receipts.

This is an asynchronous method.

Parameters

conversationId	The conversation ID.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ addConversationMark:mark:completion:

- (void) addConversationMark:	(NSArray< NSString * > *_Nonnull)	conversationIds
mark:	(AgoraChatMarkType)	mark
completion:	(void(^)(AgoraChatError *_Nullable aError))	completion

required

Marks conversations.

This method marks conversations both locally and on the server.

Parameters

conversationIds	The list of conversation IDs.
mark	The mark to add for the conversations.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ addDelegate:delegateQueue:

- (void) addDelegate:	(id< AgoraChatManagerDelegate > _Nullable)	aDelegate
delegateQueue:	(dispatch_queue_t _Nullable)	aQueue

required

Adds a delegate.

Parameters

aDelegate	The object that implements the protocol.
aQueue	(optional) The queue of calling delegate methods. If you want to run the app on the main thread, set this parameter as nil.

◆ addReaction:toMessage:completion:

- (void) addReaction:	(NSString *)	reaction
toMessage:	(NSString *)	messageId
completion:	(nullable void(^)(AgoraChatError *_Nullable))	completion

required

Adds a Reaction.

Parameters

reaction	The Reaction content.
messageId	The message ID.
completion	The completion block which contains the error code and error information if the method fails.

◆ asyncFetchGroupMessageAcksFromServer:groupId:startGroupAckId:pageSize:completion:

- (void) asyncFetchGroupMessageAcksFromServer:	(NSString *_Nonnull)	aMessageId
groupId:	(NSString *_Nonnull)	aGroupId
startGroupAckId:	(NSString *_Nonnull)	aGroupAckId
pageSize:	(int)	aPageSize
completion:	(void(^)(AgoraChatCursorResult< AgoraChatGroupMessageAck * > _Nullable aResult, AgoraChatError _Nullable error, int totalCount))	aCompletionBlock

required

Gets the read receipts of a specified group message from the server.

By getting the read receipts of a group message, you can see how many group members have read this message.

This is an asynchronous method.

Parameters

aMessageId	The message ID.
aGroupId	The group ID.
aGroupAckId	The ID of the read receipt to get from the server.
aPageSize	The number of read receipts that you expect to get on each page.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ asyncFetchHistoryMessagesFromServer:conversationType:startMessageId:fetchDirection:pageSize:completion:

- (void) asyncFetchHistoryMessagesFromServer:	(NSString *_Nonnull)	aConversationId
conversationType:	(AgoraChatConversationType)	aConversationType
startMessageId:	(NSString *_Nullable)	aStartMessageId
fetchDirection:	(AgoraChatMessageFetchHistoryDirection)	direction
pageSize:	(int)	aPageSize
completion:	("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead")	__deprecated_msg

required

Fetches conversation messages from server.

This is an asynchronous method.

Parameters

aConversationId	The conversation ID.
aConversationType	The conversation type.
aStartMessageId	The starting message ID for query. If you set this parameter as `nil` or "", the SDK gets messages from the latest one.
direction	The message search direction. See `AgoraChatMessageFetchHistoryDirection`.
aPageSize	The number of messages that you expect to get on each page. The value range is [1,50].
aCompletionBlock	The callback block, which contains the error message if the method fails.

◆ asyncFetchHistoryMessagesFromServer:conversationType:startMessageId:pageSize:completion:

- (void) asyncFetchHistoryMessagesFromServer:	(NSString *_Nonnull)	aConversationId
conversationType:	(AgoraChatConversationType)	aConversationType
startMessageId:	(NSString *_Nullable)	aStartMessageId
pageSize:	(int)	aPageSize
completion:	("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead")	__deprecated_msg

required

Gets messages in a conversation from the server.

This is an asynchronous method.

Parameters

aConversationId	The conversation ID.
aConversationType	The conversation type.
aStartMessageId	The starting message ID for query. If you set this parameter as `nil` or "", the SDK gets messages from the latest one.
aPageSize	The number of messages that you expect to get on each page.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ cleanConversationsMemoryCache

- (void) cleanConversationsMemoryCache

required

Clear all conversations in memory to release memory.

◆ deleteAllMessagesAndConversations:completion:

- (void) deleteAllMessagesAndConversations:	(BOOL)	clearServerData
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Clears all conversations and all messages in them.

This is an asynchronous method.

Parameters

clearSeverData

Whether to clear all conversations and all messages in them on the server.

YES：Yes. All conversations and all messages in them will be cleared on the server side. The current user cannot retrieve messages and conversations from the server, while this has no impact on other users.
(Default) NO：No. All local conversations and all messages in them will be cleared, while those on the server remain.

aCompletionBlock The completion callback, which contains the description of the cause to the failure.

◆ deleteConversation:isDeleteMessages:completion:

- (void) deleteConversation:	(NSString *_Nonnull)	aConversationId
isDeleteMessages:	(BOOL)	aIsDeleteMessages
completion:	(void(^)(NSString _Nullable aConversationId, AgoraChatError _Nullable aError))	aCompletionBlock

required

Deletes a conversation from the local database.

Parameters

aConversationId	The conversation ID.
aIsDeleteMessages	Whether to delete the messages in the conversation. `YES`: Yes; `NO`: No.
aCompletionBlock	The completion block, which contains the error message if the method call fails.

◆ deleteConversations:isDeleteMessages:completion:

- (void) deleteConversations:	(NSArray< AgoraChatConversation * > *_Nullable)	aConversations
isDeleteMessages:	(BOOL)	aIsDeleteMessages
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Deletes multiple conversations.

Parameters

aConversations	The conversation list.
aIsDeleteMessages	Whether to delete the messages with the conversations. `YES`: Yes; `NO`: No.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ deleteMessagesBefore:completion:

- (void) deleteMessagesBefore:	(NSUInteger)	aTimestamp
completion:	(void(^)(AgoraChatError *error))	aCompletion

required

Deletes local historical messages with a Unix timestamp before a specified one.After setting the autoLoadConversations attribute in AgoraChatOptions to false, the filtered session pull messages will not be read accurately.

Parameters

aTimestamp	The specified Unix timestamp in miliseconds. Messages with a Unix timestamp before the specified one will be deleted.
aCompletion	The completion block, which contains the error message if the method fails.

◆ deleteServerConversation:conversationType:isDeleteServerMessages:completion:

- (void) deleteServerConversation:	(NSString *_Nonnull)	aConversationId
conversationType:	(AgoraChatConversationType)	aConversationType
isDeleteServerMessages:	(BOOL)	aIsDeleteServerMessages
completion:	(void(^)(NSString _Nullable aConversationId, AgoraChatError _Nullable aError))	aCompletionBlock

required

Deletes a conversation from the server.

Parameters

aConversationId	The conversation ID.
aConversationType	The conversation type.
aIsDeleteMessages	Whether to delete the related messages with the conversation. `YES`: Yes; `NO`: No.
aCompletionBlock	The completion block, which contains the error message if the method call fails.

◆ downloadAndParseCombineMessage:completion:

- (void) downloadAndParseCombineMessage:	(AgoraChatMessage *_Nonnull)	aMessage
completion:	(void(^)(NSArray< AgoraChatMessage * > _Nullable messages, AgoraChatError _Nullable error))	aCompletionBlock

required

Download and parse the attachment in a combined message.

This is an asynchronous method.

Parameters

aMessage	The combined message object.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ downloadMessageAttachment:progress:completion:

- (void) downloadMessageAttachment:	(AgoraChatMessage *_Nonnull)	aMessage
progress:	(void(^)(int progress))	aProgressBlock
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable error))	aCompletionBlock

required

Downloads message attachment (voice, video, image or file).

The SDK automatically downloads voice messages. If the automatic download fails, you can call this method to download voice messages manually.

This is an asynchronous method.

Parameters

aMessage	The message object.
aProgressBlock	The callback block of attachment download progress. The progress value range is [0,100].
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ downloadMessageThumbnail:progress:completion:

- (void) downloadMessageThumbnail:	(AgoraChatMessage *_Nonnull)	aMessage
progress:	(void(^)(int progress))	aProgressBlock
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable error))	aCompletionBlock

required

Downloads the message thumbnail (the thumbnail of an image or the first frame of a video).

The SDK automatically downloads the thumbnail. If the auto-download fails, you can call this method to manually download the thumbnail.

Parameters

aMessage	The message object.
aProgressBlock	The callback block of attachment download progress. The progress value range is [0,100].
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ fetchHistoryMessagesFromServer:conversationType:startMessageId:fetchDirection:pageSize:error:

- (AgoraChatCursorResult< AgoraChatMessage * > *_Nullable) fetchHistoryMessagesFromServer:	(NSString *_Nonnull)	aConversationId
conversationType:	(AgoraChatConversationType)	aConversationType
startMessageId:	(NSString *_Nullable)	aStartMessageId
fetchDirection:	(AgoraChatMessageFetchHistoryDirection)	direction
pageSize:	(int)	aPageSize
error:	("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead")	__deprecated_msg

required

Gets messages in a conversation from the server.

Parameters

aConversationId	The conversation ID.
aConversationType	The conversation type.
aStartMessageId	The starting message ID for query. If you set this parameter as `nil` or "", the SDK gets messages from the latest one.
direction	The message search direction. See `AgoraChatMessageFetchHistoryDirection`.
aPageSize	The number of messages that you expect to get on each page.
pError	The error information if the method fails: Error.

Returns: The list of retrieved messages.

◆ fetchHistoryMessagesFromServer:conversationType:startMessageId:pageSize:error:

- (AgoraChatCursorResult< AgoraChatMessage * > *_Nullable) fetchHistoryMessagesFromServer:	(NSString *_Nonnull)	aConversationId
conversationType:	(AgoraChatConversationType)	aConversationType
startMessageId:	(NSString *_Nullable)	aStartMessageId
pageSize:	(int)	aPageSize
error:	("Use -fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion: instead")	__deprecated_msg

required

Gets messages in a conversation from the server.

Parameters

aConversationId	The conversation ID.
aConversationType	The conversation type.
aStartMessageId	The starting message ID for query. If you set this parameter as `nil` or "", the SDK gets messages from the latest one.
aPageSize	The number of messages that you expect to get on each page.
pError	The error information if the method fails: Error.

Returns: The list of retrieved messages.

◆ fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion:

- (void) fetchMessagesFromServerBy:	(NSString *)	conversationId
conversationType:	(AgoraChatConversationType)	type
cursor:	(NSString *_Nullable)	cursor
pageSize:	(NSUInteger)	pageSize
option:	(AgoraChatFetchServerMessagesOption *_Nullable)	option
completion:	(void(^)(AgoraChatCursorResult< AgoraChatMessage * > _Nullable result, AgoraChatError _Nullable aError))	aCompletionBlock

required

Get the historical messages of the specified session from the server page according to the message pull parameter configuration interface (AgoraChatFetchServerMessagesOption). When the number of returned messages is less than the expected number of messages, it means that the server has no more historical messages.

Parameters

conversationId	The conversation ID. One-to-one chat: The ID of the peer user; Group chat: The group ID; Chat room: The chat room ID.
type	The conversation type.
cursor	The cursor position from which to start querying data.
pageSize	The number of messages that you expect to get on each page. The value range is [1,50].
option	The parameter configuration class for pulling historical messages from the server. See `AgoraChatFetchServerMessagesOption`.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ fetchSupportedLanguages:

- (void) fetchSupportedLanguages: (void(^)(NSArray< AgoraChatTranslateLanguage * > *_Nullable languages, AgoraChatError *_Nullable error)) aCompletionBlock

required

Gets all languages supported by the translation service.

Parameters

aCompletionBlock The completion block, which contains the error message if the method fails.

◆ filterConversationsFromDB:filter:

- (NSArray< AgoraChatConversation * > *_Nullable) filterConversationsFromDB:	(BOOL)	cleanMemoryCache
filter:	(filterConversationsFromDB(cleanMemoryCache:filter:))	NS_SWIFT_NAME

required

Gets local conversations by filter.

The SDK loads conversations from the local database by the specified filter conditions.

Ensure that you call this method upon login success.

Parameters

cleanMemoryCache	Whether to clear cached conversations in memory.
filter	The filter. The return value `YES` indicates that the conversation is returned and `false` indicates that the conversation is not returned.

Returns: The conversation list of the NSArray<AgoraChatConversation *> * type.

◆ getAllConversations

- (NSArray< AgoraChatConversation * > *_Nullable) getAllConversations

required

Gets all local conversations.

The SDK loads the conversations from the memory first. If no conversation is found in the memory, the SDK loads from the local database.

Returns: The conversation list of the NSArray<AgoraChatConversation *> * type.

◆ getAllConversations:

- (NSArray< AgoraChatConversation * > *_Nullable) getAllConversations: (BOOL) isSort

required

Gets all local conversations.

The SDK loads the conversations from the memory first. If there is no conversation is in the memory, the SDK loads from the local database.

Parameters

isSort

Whether to sort the conversations.

YES: Yes. The SDK returns conversations in the descending order of the timestamp of the latest message in them, with the pinned ones at the top of the list and followed by the unpinned ones.
NO: No.

Returns: The conversation list of the NSArray<AgoraChatConversation *> * type.

◆ getConversation:type:createIfNotExist:

- (AgoraChatConversation *_Nullable) getConversation:	(NSString *_Nonnull)	aConversationId
type:	(AgoraChatConversationType)	aType
createIfNotExist:	(BOOL)	aIfCreate

required

Gets a conversation from the local database.

Parameters

aConversationId	The conversation ID.
aType	The conversation type.
aIfCreate	Whether to create the conversation if it does not exist: `YES`: Yes; `NO`: No.

Returns: The conversation object.

◆ getConversation:type:createIfNotExist:isThread:

- (AgoraChatConversation *_Nullable) getConversation:	(NSString *_Nonnull)	aConversationId
type:	(AgoraChatConversationType)	aType
createIfNotExist:	(BOOL)	aIfCreate
isThread:	(BOOL)	isThread

required

Gets a conversation from the local database.

Parameters

aConversationId	The conversation ID.
aType	The conversation type.
aIfCreate	Whether to create the conversation if it does not exist. `YES`: Yes; `NO`: No.
isThread	Whether it is thread conversation. That is, whether the conversation is of the `threadChat` type. `YES`: Yes; `NO`: No.

Returns: The conversation object.

◆ getConversationsFromServer:

- (void) getConversationsFromServer:	(4_0_0)
	("Use -IAgoraChatManager getConversationsFromServerWithCursor:pageSize:completion")	EM_DEPRECATED_IOS

required

Gets all conversations from the server.

Parameters

aCompletionBlock The completion block, which contains the error message if the method fails.

◆ getConversationsFromServerByPage:pageSize:completion:

- (void) getConversationsFromServerByPage:	(NSUInteger)	pageNumber
pageSize:	(NSUInteger)	pageSize
completion:	(4_0_0)
	("Use -IAgoraChatManager getConversationsFromServerWithCursor:pageSize:completion")	EM_DEPRECATED_IOS

required

Gets conversations from the server with pagination.

Parameters

pageNumber	The current page number, starting from 1.
pageSize	The number of conversations that you expect to get on each page.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ getConversationsFromServerWithCursor:filter:completion:

- (void) getConversationsFromServerWithCursor:	(NSString *_Nullable)	cursor
filter:	(AgoraChatConversationFilter *_Nonnull)	filter
completion:	(nonnull void(^)(AgoraChatCursorResult< AgoraChatConversation * > _Nullable result, AgoraChatError _Nullable error))	completionBlock

required

Gets the conversations from the server with pagination according to the conversation filter class.

Parameters

cursor	The position from which to start getting data. If you pass in `nil` or `@""`, the SDK retrieves conversations from the latest marked one.
filter	The conversation filter options: conversation mark and the number of conversations to retrieve on each page.
aCompletionBlock	The completion block, which contains the conversation list and the cursor for the next query. When the cursor is empty, all data is already retrieved.

◆ getConversationsFromServerWithCursor:pageSize:completion:

- (void) getConversationsFromServerWithCursor:	(nullable NSString *)	cursor
pageSize:	(UInt8)	pageSize
completion:	(nonnull void(^)(AgoraChatCursorResult< AgoraChatConversation * > _Nullable result, AgoraChatError _Nullable error))	completionBlock

required

Get the list of conversations from the server with pagination.

The SDK retrieves the list of conversations in the reverse chronological order of their active time (the timestamp of the last message).

If there is no message in the conversation, the SDK retrieves the list of conversations in the reverse chronological order of their creation time.

Parameters

cursor	The position from which to start getting data. If you pass in `nil` or `@""`, the SDK retrieves conversations from the latest active one.
pageSize	The number of conversations that you expect to get on each page. The value range is [1,50].
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ getConversationWithConvId:

- (AgoraChatConversation *_Nullable) getConversationWithConvId: (NSString *_Nullable) aConversationId

required

Gets a conversation from the local database.

Parameters

aConversationId The conversation ID.

Returns: The conversation object.

◆ getMessageAttachmentPath:

- (NSString *_Nullable) getMessageAttachmentPath: (NSString *_Nonnull) aConversationId

required

Gets the local path of message attachments in a conversation.

When a conversation is deleted, the message attachments in the conversation will also be deleted.

Parameters

aConversationId The conversation ID.

Returns: The attachment path.

◆ getMessageCountWithCompletion:

- (void) getMessageCountWithCompletion: (void(^)(NSInteger count, AgoraChatError *_Nullable aError)) completion

required

Get the message count from db.

Parameters

completion The completion block, which contains the number of message count in db.

◆ getMessageWithMessageId:

- (AgoraChatMessage *_Nullable) getMessageWithMessageId: (NSString *_Nonnull) aMessageId

required

Gets the specified message.

Parameters

aMessageId The message ID.

Returns: AgoraChatMessage The message content.

◆ getPinnedConversationsFromServerWithCursor:pageSize:completion:

- (void) getPinnedConversationsFromServerWithCursor:	(nullable NSString *)	cursor
pageSize:	(UInt8)	limit
completion:	(nonnull void(^)(AgoraChatCursorResult< AgoraChatConversation * > _Nullable result, AgoraChatError _Nullable error))	completionBlock

required

Gets the list of pinned conversations from the server with pagination.

The SDK returns the pinned conversations in the reverse chronological order of their pinning.

Parameters

cursor	The position from which to start getting data. If you pass in `nil` or `@""`, the SDK retrieves conversations from the latest pinned one.
pageSize	The number of conversations that you expect to get on each page. The value range is [1,50].
completionBlock	The completion block, which contains the error message if the method fails.

◆ getPinnedMessagesFromServer:completion:

- (void) getPinnedMessagesFromServer:	(NSString *_Nonnull)	conversationId
completion:	(void(^)(NSArray< AgoraChatMessage * > _Nullable messages, AgoraChatError _Nullable aError))	aCompletionBlock

required

Gets the list of pinned messages in a conversation.

Parameters

conversationId	The conversation ID.
aCompletionBlock	The completion block, which contains the list of pinned messages if the call succeeds, or contains the error message if the method fails.

◆ getReactionDetail:reaction:cursor:pageSize:completion:

- (void) getReactionDetail:	(NSString *)	messageId
reaction:	(NSString *)	reaction
cursor:	(nullable NSString *)	cursor
pageSize:	(uint64_t)	pageSize
completion:	(void(^)(AgoraChatMessageReaction , NSString _Nullable cursor, AgoraChatError *_Nullable))	completion

required

Uses the pagination to get the Reaction detail list of a chat group message.

Parameters

messageId	The message ID.
reaction	The Reaction content.
cursor	The position from which to start getting data. If it is set to `nil` or `@""` at the first call, the SDK retrieves Reactions in the chronological order of their creation time.
pageSize	The number of Reactions that you expect to get on each page. The value range is [1,100].
completion	The completion block, which contains the Reaction list and the cursor for the next query. When the cursor is `nil`, all data is already fetched.

◆ getReactionList:groupId:chatType:completion:

- (void) getReactionList:	(NSArray< NSString * > *)	messageIds
groupId:	(nullable NSString *)	groupId
chatType:	(AgoraChatType)	chatType
completion:	(void(^)(NSDictionary< NSString , NSArray< AgoraChatMessageReaction > * > , AgoraChatError _Nullable))	completion

required

Gets the Reaction list.

Parameters

messageId	The message ID.
groupId	The group ID. This parameter is invalid only for group chat.
chatType	The chat type. Only one-to-one chat (`AgoraChatTypeChat` and group chat (`AgoraChatTypeGroupChat`) are allowed.
completion	The completion block which contains the error code and error information if the method fails.

◆ importConversations:completion:

- (void) importConversations:	(NSArray< AgoraChatConversation * > *_Nullable)	aConversations
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Imports multiple conversations to the local database.

Parameters

aConversations	The conversation list.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ importMessages:completion:

- (void) importMessages:	(NSArray< AgoraChatMessage * > *_Nonnull)	aMessages
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Imports multiple messages to the local database.

Parameters

aMessages	The message list.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:

- (NSArray< AgoraChatMessage * > *) loadMessagesWithKeyword:	(NSString *)	aKeywords
timestamp:	(long long)	aTimestamp
count:	(int)	aCount
fromUser:	(NSString *)	aSender
searchDirection:	(AgoraChatMessageSearchDirection)	aDirection

required

Loads messages with the specified keyword from the local database.

This method returns messages in chronological order.

This is a synchronous method and blocks the current thread.

Parameters

aKeyword	The keyword for message search. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aTimestamp	The message timestamp threshold for loading. If you set this parameter as a negative value, the SDK loads messages from the latest.
aCount	The number of messages to load. If you set this parameter less than 1, the SDK gets one message from the local database.
aSender	The message sender. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aDirection	The message search direction. See `AgoraChatMessageSearchDirection`. `UP`: The SDK retrieves messages in the descending order of the timestamp included in them. `DOWN`：The SDK retrieves messages in the ascending order of the timestamp included in them.

Returns: The list of retrieved messages. The message list is of the array type. For elements in the array, see AgoraChatMessage.

◆ loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:completion:

- (void) loadMessagesWithKeyword:	(NSString *)	aKeywords
timestamp:	(long long)	aTimestamp
count:	(int)	aCount
fromUser:	(NSString *)	aSender
searchDirection:	(AgoraChatMessageSearchDirection)	aDirection
completion:	(void(^)(NSArray< AgoraChatMessage * > aMessages, AgoraChatError aError))	aCompletionBlock

required

Loads messages with the specified keyword from the local database.

This method returns messages in chronological order.

Parameters

aKeyword	The keyword for message search. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aTimestamp	The message timestamp threshold for loading. If you set this parameter as a negative value, the SDK loads messages from the latest.
aCount	The number of messages to load. If you set this parameter less than 1, the SDK gets one message from the local database.
aSender	The sender of the message. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aDirection	The message search direction. See `AgoraChatMessageSearchDirection`. `UP`: The SDK retrieves messages in the descending order of the timestamp included in them. `DOWN`：The SDK retrieves messages in the ascending order of the timestamp included in them.
aCompletionBlock	The completion block which contains the error code and error information if the method fails.

◆ loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:scope:completion:

- (void) loadMessagesWithKeyword:	(NSString *)	aKeywords
timestamp:	(long long)	aTimestamp
count:	(int)	aCount
fromUser:	(NSString *)	aSender
searchDirection:	(AgoraChatMessageSearchDirection)	aDirection
scope:	(AgoraChatMessageSearchScope)	aScope
completion:	(void(^)(NSArray< AgoraChatMessage * > aMessages, AgoraChatError aError))	aCompletionBlock

required

Loads messages with the specified keyword from the local database.

The SDK returns messages in the chronological order.

Parameters

aKeyword	The keyword for message search. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aTimestamp	The Unix timestamp threshold for message search. The unit is millisecond. If you set this parameter as a negative value, the SDK loads messages from the latest one.
aCount	The number of messages to load. If you set this parameter to 0 or less, the SDK gets one message from the local database.
aSender	The sender of the message. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aDirection	The message search direction. See `AgoraChatMessageSearchDirection`. `UP`: The SDK retrieves messages in the descending order of the timestamp included in them. `DOWN`：The SDK retrieves messages in the ascending order of the timestamp included in them.
aScope	The message search scope. See `AgoraChatMessageSearchScope`.
aCompletionBlock	The completion block which contains the error code and error information if the method fails.

◆ loadMessagesWithType:timestamp:count:fromUser:searchDirection:

- (NSArray< AgoraChatMessage * > *_Nullable) loadMessagesWithType:	(AgoraChatMessageBodyType)	aType
timestamp:	(long long)	aTimestamp
count:	(int)	aCount
fromUser:	(NSString *_Nullable)	aUsername
searchDirection:	(AgoraChatMessageSearchDirection)	aDirection

required

Loads messages with the specified keyword from the local database.

This method returns messages in chronological order.

This is a synchronous method and blocks the current thread.

Parameters

aType	The message type to load.
aTimestamp	The message timestamp threshold for loading. If you set this parameter as a negative value, the SDK loads messages from the latest one.
aCount	The number of messages to load. If you set this parameter to a value less than 1, the SDK gets one message from the local database.
aUsername	The message sender. It is optional. If you set this parameter as `nil`, the SDK gets messages while ignoring this parameter.
aDirection	The message search direction. See `AgoraChatMessageSearchDirection`. `UP`: The SDK retrieves messages in the descending order of the timestamp included in them. `DOWN`：The SDK retrieves messages in the ascending order of the timestamp included in them.

Returns: The list of retrieved messages. The message list is of the array type. For elements in the array, see AgoraChatMessage.

◆ loadMessagesWithType:timestamp:count:fromUser:searchDirection:completion:

- (void) loadMessagesWithType:	(AgoraChatMessageBodyType)	aType
timestamp:	(long long)	aTimestamp
count:	(int)	aCount
fromUser:	(NSString *)	aUsername
searchDirection:	(AgoraChatMessageSearchDirection)	aDirection
completion:	(void(^)(NSArray< AgoraChatMessage * > aMessages, AgoraChatError aError))	aCompletionBlock

required

Loads messages with the specified keyword from the local database.

This method returns messages in chronological order.

Parameters

aType	The message type to load.
aTimestamp	The message timestamp threshold for loading. If you set this parameter as a negative value, the SDK loads messages from the latest one.
aCount	The number of messages to load. If you set this parameter to a value less than 1, the SDK gets one message from the local database.
aUsername	The message sender. It is optional. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aDirection	The message search direction. See `AgoraChatMessageSearchDirection`. `UP`: The SDK retrieves messages in the descending order of the timestamp included in them. `DOWN`：The SDK retrieves messages in the ascending order of the timestamp included in them.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ markAllConversationsAsRead

- (AgoraChatError *) markAllConversationsAsRead

required

Marks all conversations as read.

This method works only for local conversations.

◆ modifyMessage:body:completion:

- (void) modifyMessage:	(NSString *_Nonnull)	messageId
body:	(AgoraChatMessageBody *_Nonnull)	body
completion:	(void(^)(AgoraChatError _Nullable error, AgoraChatMessage _Nullable message))	completionBlock

required

Modifies a local message or a message at the server side.

You can call this method to only modify a text message in one-to-one chats or group chats, but not in chat rooms.

Parameters

message	The ID of the message to modify.
body	The modified message body(AgoraChatTextMessageBody).
completionBlock	The completion block, which contains the error message if the method fails.

◆ pinConversation:isPinned:completionBlock:

- (void) pinConversation:	(nonnull NSString *)	conversationId
isPinned:	(BOOL)	isPinned
completionBlock:	(nullable void(^)(AgoraChatError *_Nullable error))	completionBlock

required

Sets whether to pin a conversation.

Parameters

conversationId	The conversation ID.
isPinned	Whether to pin a conversation: `true`：Yes. `false`: No. The conversation is unpinned.
completionBlock	The completion block, which contains the error message if the method fails.

◆ pinMessage:completion:

- (void) pinMessage:	(NSString *_Nonnull)	messageId
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable aError))	aCompletionBlock

required

Pins a message.

Parameters

messageId	The ID of the message to be pinned.
aCompletionBlock	The completion block, which contains the pinned message object if the call succeeds, or contains the error message if the method fails.

◆ recallMessageWithMessageId:completion:

- (void) recallMessageWithMessageId:	(NSString *_Nonnull)	aMessageId
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Recalls a message.

This is an asynchronous method.

Parameters

aMessageId	The message ID
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ recallMessageWithMessageId:ext:completion:

- (void) recallMessageWithMessageId:	(NSString *_Nonnull)	aMessageId
ext:	(NSString *_Nullable)	ext
completion:	(void(^)(AgoraChatError *_Nullable))	aCompletionBlock

required

Recalls a message.

This is an asynchronous method.

Parameters

aMessageId	The ID of the message to recall.
ext	The information to be transparently transmitted during message recall. The information can be a string or a JSONString.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ removeConversationMark:mark:completion:

- (void) removeConversationMark:	(NSArray< NSString * > *_Nonnull)	conversationIds
mark:	(AgoraChatMarkType)	mark
completion:	(void(^)(AgoraChatError *_Nullable aError))	completion

required

Unmarks conversations.

This method unmarks conversations both locally and on the server.

Parameters

conversationIds	The list of conversation IDs.
mark	The conversation mark to remove.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ removeDelegate:

- (void) removeDelegate: (id< AgoraChatManagerDelegate > _Nonnull) aDelegate

required

Removes a delegate.

Parameters

aDelegate The delegate to be removed.

◆ removeMessagesFromServerWithConversation:messageIds:completion:

- (void) removeMessagesFromServerWithConversation:	(AgoraChatConversation *_Nonnull)	conversation
messageIds:	(NSArray< __kindof NSString * > *_Nonnull)	messageIds
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Removes messages in a conversation (from both local storage and the server).

Parameters

conversation	The AgoraChatConversation object.
messageIds	A string array of message IDs to delete.
completion	The completion block, which contains the error message if the method fails.

◆ removeMessagesFromServerWithConversation:timeStamp:completion:

- (void) removeMessagesFromServerWithConversation:	(AgoraChatConversation *_Nonnull)	conversation
timeStamp:	(NSTimeInterval)	beforeTimeStamp
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Removes messages in a conversation (from both local storage and the server).

Parameters

conversation	The AgoraChatConversation object.
beforeTimeStamp	The specified Unix timestamp in miliseconds. Messages with a timestamp before the specified one will be removed from the conversation.
completion	The completion block, which contains the error message if the method fails.

◆ removeReaction:fromMessage:completion:

- (void) removeReaction:	(NSString *)	reaction
fromMessage:	(NSString *)	messageId
completion:	(nullable void(^)(AgoraChatError *_Nullable))	completion

required

Removes a Reaction.

Parameters

reaction	The Reaction content.
messageId	The message ID.
completion	The completion block which contains the error code and error information if the method fails.

◆ reportMessageWithId:tag:reason:completion:

- (void) reportMessageWithId:	(NSString *_Nonnull)	aMessageId
tag:	(NSString *_Nonnull)	aTag
reason:	(NSString *_Nonnull)	aReason
completion:	(void(^)(AgoraChatError *_Nullable error))	aCompletion

required

Reports an inappropriate message.

This is an asynchronous method.

Parameters

aMessageId	The ID of the inappropriate message.
aTag	The tag of the illegal message. You need to type a custom tag, like `porn` or `ad`. This parameter corresponds to the "Label" field on the message reporting history page of the console.
aReason	he reporting reason. You need to type a specific reason. This parameter corresponds to the "Reason" field on the message reporting history page of the console.
aCompletion	The completion block, which contains the error message if the method fails.

◆ resendMessage:progress:completion:

- (void) resendMessage:	(AgoraChatMessage *_Nonnull)	aMessage
progress:	(void(^)(int progress))	aProgressBlock
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable error))	aCompletionBlock

required

Resends a message.

Parameters

aMessage	The message object.
aProgressBlock	The callback block of attachment upload progress. The progress value range is [0,100].
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ searchMessagesWithTypes:timestamp:count:fromUser:searchDirection:completion:

- (void) searchMessagesWithTypes:	(NSArray< NSNumber * > *_Nonnull)	aTypes
timestamp:	(long long)	aTimestamp
count:	(int)	aCount
fromUser:	(NSString *_Nullable)	aUsername
searchDirection:	(AgoraChatMessageSearchDirection)	aDirection
completion:	(void(^)(NSArray< AgoraChatMessage * > _Nullable aMessages, AgoraChatError _Nullable aError))	aCompletionBlock

required

Loads messages with the specified keyword from the local database.

This method returns messages in chronological order.

Parameters

aTypes	The message types to load. Types include txt (text message), img (image message), loc (location message), audio (audio message), video (video message), file (file message), and cmd (command message). `AgoraChatMessageBodyType`
aTimestamp	The message timestamp threshold for loading. If you set this parameter as a negative value, the SDK loads messages from the latest one.
aCount	The number of messages to load. If you set this parameter to a value less than 1, the SDK gets one message from the local database.
aUsername	The message sender. It is optional. If you set this parameter as `nil`, the SDK ignores this parameter when retrieving messages.
aDirection	The message search direction. See `AgoraChatMessageSearchDirection`. `UP`: The SDK retrieves messages in the descending order of the timestamp included in them. `DOWN`：The SDK retrieves messages in the ascending order of the timestamp included in them.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ sendGroupMessageReadAck:toGroup:content:completion:

- (void) sendGroupMessageReadAck:	(NSString *_Nonnull)	aMessageId
toGroup:	(NSString *_Nonnull)	aGroupId
content:	(NSString *_Nullable)	aContent
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Sends the read receipt for a group message.

This is an asynchronous method.

Parameters

aMessageId	The message ID.
aGroupId	The group ID.
aContent	The message content.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ sendMessage:progress:completion:

- (void) sendMessage:	(AgoraChatMessage *_Nonnull)	aMessage
progress:	(void(^)(int progress))	aProgressBlock
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable error))	aCompletionBlock

required

Sends a message.

This is an asynchronous method.

Parameters

aMessage	The message instance.
aProgressBlock	The callback block of attachment upload progress. The progress value range is [0,100].
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ sendMessageReadAck:toUser:completion:

- (void) sendMessageReadAck:	(NSString *_Nonnull)	aMessageId
toUser:	(NSString *_Nonnull)	aUsername
completion:	(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

required

Sends the read receipt for a message.

This is an asynchronous method.

Parameters

aMessageId	The message ID.
aUsername	The user ID of the recipient of the read receipt.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ translateMessage:targetLanguages:completion:

- (void) translateMessage:	(AgoraChatMessage *_Nonnull)	aMessage
targetLanguages:	(NSArray< NSString * > *_Nonnull)	aLanguages
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable error))	aCompletionBlock

required

Translates a message.

Parameters

aMessage	The message object.
aLanguages	The list of target language codes.
aCompletionBlock	The completion block, which contains the error message if the method fails.

◆ unpinMessage:completion:

- (void) unpinMessage:	(NSString *_Nonnull)	messageId
completion:	(void(^)(AgoraChatMessage _Nullable message, AgoraChatError _Nullable aError))	aCompletionBlock

required

Unpins a message.

Parameters

messageId	The ID of the message to be unpinned.
aCompletionBlock	The completion block, which contains the unpinned message object if the call succeeds, or contains the error message if the method fails.

◆ updateMessage:completion:

- (void) updateMessage:	(AgoraChatMessage *_Nonnull)	aMessage
completion:	(void(^)(AgoraChatMessage _Nullable aMessage, AgoraChatError _Nullable aError))	aCompletionBlock

required

Updates a message in the local database.

This method updates the message in both the memory and the local database at the same time.

The message ID cannot be updated.

Parameters

aMessage	The message instance.
aCompletionBlock	The completion block, which contains the error message if the method fails.

The documentation for this protocol was generated from the following file:

AgoraChat.framework/Headers/IAgoraChatManager.h

Instance Methods

Detailed Description

Method Documentation

◆ ackConversationRead:completion:

◆ addConversationMark:mark:completion:

◆ addDelegate:delegateQueue:

◆ addReaction:toMessage:completion:

◆ asyncFetchGroupMessageAcksFromServer:groupId:startGroupAckId:pageSize:completion:

◆ asyncFetchHistoryMessagesFromServer:conversationType:startMessageId:fetchDirection:pageSize:completion:

◆ asyncFetchHistoryMessagesFromServer:conversationType:startMessageId:pageSize:completion:

◆ cleanConversationsMemoryCache

◆ deleteAllMessagesAndConversations:completion:

◆ deleteConversation:isDeleteMessages:completion:

◆ deleteConversations:isDeleteMessages:completion:

◆ deleteMessagesBefore:completion:

◆ deleteServerConversation:conversationType:isDeleteServerMessages:completion:

◆ downloadAndParseCombineMessage:completion:

◆ downloadMessageAttachment:progress:completion:

◆ downloadMessageThumbnail:progress:completion:

◆ fetchHistoryMessagesFromServer:conversationType:startMessageId:fetchDirection:pageSize:error:

◆ fetchHistoryMessagesFromServer:conversationType:startMessageId:pageSize:error:

◆ fetchMessagesFromServerBy:conversationType:cursor:pageSize:option:completion:

◆ fetchSupportedLanguages:

◆ filterConversationsFromDB:filter:

◆ getAllConversations

◆ getAllConversations:

◆ getConversation:type:createIfNotExist:

◆ getConversation:type:createIfNotExist:isThread:

◆ getConversationsFromServer:

◆ getConversationsFromServerByPage:pageSize:completion:

◆ getConversationsFromServerWithCursor:filter:completion:

◆ getConversationsFromServerWithCursor:pageSize:completion:

◆ getConversationWithConvId:

◆ getMessageAttachmentPath:

◆ getMessageCountWithCompletion:

◆ getMessageWithMessageId:

◆ getPinnedConversationsFromServerWithCursor:pageSize:completion:

◆ getPinnedMessagesFromServer:completion:

◆ getReactionDetail:reaction:cursor:pageSize:completion:

◆ getReactionList:groupId:chatType:completion:

◆ importConversations:completion:

◆ importMessages:completion:

◆ loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:

◆ loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:completion:

◆ loadMessagesWithKeyword:timestamp:count:fromUser:searchDirection:scope:completion:

◆ loadMessagesWithType:timestamp:count:fromUser:searchDirection:

◆ loadMessagesWithType:timestamp:count:fromUser:searchDirection:completion:

◆ markAllConversationsAsRead

◆ modifyMessage:body:completion:

◆ pinConversation:isPinned:completionBlock:

◆ pinMessage:completion:

◆ recallMessageWithMessageId:completion:

◆ recallMessageWithMessageId:ext:completion:

◆ removeConversationMark:mark:completion:

◆ removeDelegate:

◆ removeMessagesFromServerWithConversation:messageIds:completion:

◆ removeMessagesFromServerWithConversation:timeStamp:completion:

◆ removeReaction:fromMessage:completion:

◆ reportMessageWithId:tag:reason:completion:

◆ resendMessage:progress:completion:

◆ searchMessagesWithTypes:timestamp:count:fromUser:searchDirection:completion:

◆ sendGroupMessageReadAck:toGroup:content:completion:

◆ sendMessage:progress:completion:

◆ sendMessageReadAck:toUser:completion:

◆ translateMessage:targetLanguages:completion:

◆ unpinMessage:completion:

◆ updateMessage:completion: