Class ChatManager

The chat manager class, responsible for sending and receiving messages, managing conversations (including loading and deleting conversations), and downloading attachments.

The sample code for sending a text message is as follows:

let msg = ChatMessage.createTextMessage(
  'asteriskhx2',
  Date.now().toString(),
  ChatMessageChatType.PeerChat
);
let callback = new (class s implements ChatMessageStatusCallback {
  onProgress(progress: number): void {
    chatlog.log('ConnectScreen.sendMessage.onProgress ', progress);
  }
  onError(error: ChatError): void {
    chatlog.log('ConnectScreen.sendMessage.onError ', error);
  }
  onSuccess(): void {
    chatlog.log('ConnectScreen.sendMessage.onSuccess');
  }
  onReadAck(): void {
    chatlog.log('ConnectScreen.sendMessage.onReadAck');
  }
  onDeliveryAck(): void {
    chatlog.log('ConnectScreen.sendMessage.onDeliveryAck');
  }
  onStatusChanged(status: ChatMessageStatus): void {
    chatlog.log('ConnectScreen.sendMessage.onStatusChanged ', status);
  }
})();
ChatClient.getInstance()
  .chatManager.sendMessage(msg, callback)
  .then((nmsg: ChatMessage) => {
    chatlog.log(`${msg}, ${nmsg}`);
  })
  .catch();

Hierarchy

BaseManager
- ChatManager

Index

Constructors

constructor

new ChatManager(): ChatManager
Returns ChatManager
Overrides BaseManager.constructor

Properties

`Protected` `Optional`_eventEmitter

_eventEmitter?: NativeEventEmitter

`Static`TAG

TAG: string = 'ChatManager'

Methods

addMessageListener

addMessageListener(listener): void
Adds a message listener.
Parameters
- listener: ChatMessageEventListener
  The message listener to add.
Returns void

addReaction

addReaction(reaction, msgId): Promise<void>
Adds a Reaction.
Parameters
- reaction: string
  The Reaction content.
- msgId: string
  The ID of the message for which the Reaction is added.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

addRemoteAndLocalConversationsMark

addRemoteAndLocalConversationsMark(convIds, mark): Promise<void>
Marks conversations.

This method marks conversations both locally and on the server.
Parameters
- convIds: string[]
  The list of conversation IDs.
- mark: ChatConversationMarkType
  The mark to add for the conversations. See ChatConversationMarkType.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

createChatThread

createChatThread(name, msgId, parentId): Promise<ChatMessageThread>
Creates a message thread.

Each member of the group where the thread belongs can call this method.

Upon the creation of a message thread, the following will occur:
- In a single-device login scenario, each member of the group to which the message thread belongs will receive the ChatMessageEventListener.onChatMessageThreadCreated callback. You can listen for message thread events by setting ChatMessageEventListener.
- In a multi-device login scenario, the devices will receive the ChatMultiDeviceEventListener.onThreadEvent callback. You can listen for message thread events by setting ChatMultiDeviceEventListener.
Parameters
- name: string
  The name of the new message thread. It can contain a maximum of 64 characters.
- msgId: string
  The ID of the parent message.
- parentId: string
  The parent ID, which is the group ID.
Returns Promise<ChatMessageThread>
If success, the new message thread object is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

deleteAllMessageAndConversation

deleteAllMessageAndConversation(clearServerData?): Promise<void>
Clears all conversations and all messages in them.
Parameters
- clearServerData: boolean = false
  Whether to clear all conversations and all messages in them on the server.
  - true：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) false：No. All local conversations and all messages in them will be cleared, while those on the server remain.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

deleteConversation

deleteConversation(convId, withMessage?): Promise<void>
Deletes a conversation and its local messages from the local database.
Parameters
- convId: string
  The conversation ID.
- withMessage: boolean = true
  Whether to delete the historical messages with the conversation.
  - (Default) true: Yes.
  - false: No.
Returns Promise<void>
Whether the conversation is successfully deleted.
- true: Yes.
- false: No.
Throws
A description of the exception. See ChatError.

deleteConversationAllMessages

deleteConversationAllMessages(convId, convType, isChatThread?): Promise<void>
Deletes all messages in the conversation from both the memory and local database.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

deleteMessage

deleteMessage(convId, convType, msgId, isChatThread?): Promise<void>
Deletes a message from the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- msgId: string
  The ID of the message to delete.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

deleteMessagesBeforeTimestamp

deleteMessagesBeforeTimestamp(timestamp): Promise<void>
Deletes local messages with timestamp that is before the specified one.
Parameters
- timestamp: number
  The specified Unix timestamp(milliseconds).
Returns Promise<void>
Throws
A description of the exception. See ChatError.

deleteMessagesWithTimestamp

deleteMessagesWithTimestamp(convId, convType, params, isChatThread?): Promise<void>
Deletes messages sent or received in a certain period from the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- params: {
  endTs: number;
  startTs: number;
  }
  - endTs: number
  - startTs: number
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Params
params
- startTs: The starting UNIX timestamp for message deletion. The unit is millisecond.
- endTs: The end UNIX timestamp for message deletion. The unit is millisecond.
Throws
A description of the exception. See ChatError.

deleteRemoteAndLocalConversationsMark

deleteRemoteAndLocalConversationsMark(convIds, mark): Promise<void>
Unmarks conversations.

This method unmarks conversations both locally and on the server.
Parameters
- convIds: string[]
  The list of conversation IDs.
- mark: ChatConversationMarkType
  The conversation mark to remove. See ChatConversationMarkType.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

destroyChatThread

destroyChatThread(chatThreadId): Promise<void>
Destroys the message thread.

Only the owner or admins of the group where the message thread belongs can call this method.

Note
- In a single-device login scenario, each member of the group to which the message thread belongs will receive the ChatMessageEventListener.onChatMessageThreadDestroyed callback. You can listen for message thread events by setting ChatMessageEventListener.
- In a multi-device login scenario, the devices will receive the ChatMultiDeviceEventListener.onThreadEvent callback. You can listen for message thread events by setting ChatMultiDeviceEventListener.
Parameters
- chatThreadId: string
  The message thread ID.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

downloadAttachment

downloadAttachment(message, callback?): Promise<void>
Downloads the message attachment.

You can also call this method if the attachment fails to be downloaded automatically.
Parameters
- message: ChatMessage
  The ID of the message with the attachment to be downloaded.
- Optionalcallback: ChatMessageStatusCallback
  The listener that listens for message changes.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

downloadAttachmentInCombine

downloadAttachmentInCombine(message, callback?): Promise<void>
Downloads the message attachment.

Note This method is only used to download messages attachment in combine type message or thread type.

Note The bottom layer will not get the original message object and will use the json converted message object.

You can also call this method if the attachment fails to be downloaded automatically.
Parameters
- message: ChatMessage
  The ID of the message with the attachment to be downloaded.
- Optionalcallback: ChatMessageStatusCallback
  The listener that listens for message changes.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

downloadThumbnail

downloadThumbnail(message, callback?): Promise<void>
Downloads the message thumbnail.
Parameters
- message: ChatMessage
  The ID of the message with the thumbnail to be downloaded. Only the image messages and video messages have a thumbnail.
- Optionalcallback: ChatMessageStatusCallback
Returns Promise<void>
Throws
A description of the exception. See ChatError.

downloadThumbnailInCombine

downloadThumbnailInCombine(message, callback?): Promise<void>
Downloads the message thumbnail.

Note This method is only used to download messages thumbnail in combine type message.
Parameters
- message: ChatMessage
  The ID of the message with the thumbnail to be downloaded. Only the image messages and video messages have a thumbnail.
- Optionalcallback: ChatMessageStatusCallback
Returns Promise<void>
Throws
A description of the exception. See ChatError.

fetchAllConversations

fetchAllConversations(): Promise<ChatConversation[]>
Returns Promise<ChatConversation[]>
The conversation list of the current user.
Deprecated
2023-07-24

Gets the conversation list from the server.

Note
- To use this function, you need to contact our business manager to activate it.
- After this function is activated, users can pull 10 conversations within 7 days by default (each conversation contains the latest historical message).
- If you want to adjust the number of conversations or time limit, contact our business manager.
Throws
A description of the exception. See ChatError.

fetchChatThreadFromServer

fetchChatThreadFromServer(chatThreadId): Promise<undefined | ChatMessageThread>
Gets the details of the message thread from the server.
Parameters
- chatThreadId: string
  The message thread ID.
Returns Promise<undefined | ChatMessageThread>
If success, the details of the message thread are returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchChatThreadWithParentFromServer

fetchChatThreadWithParentFromServer(parentId, cursor?, pageSize?): Promise<ChatCursorResult<ChatMessageThread>>
Uses the pagination to get the list of message threads in the specified group.

This method gets data from the server.
Parameters
- parentId: string
  The parent ID, which is the group ID.
- cursor: string = ''
  The position from which to start getting data. At the first method call, if you set cursor to null or an empty string, the SDK will get data in the reverse chronological order of when message threads are created.
- pageSize: number = 20
  The number of message threads that you expect to get on each page. The value range is [1,400].
Returns Promise<ChatCursorResult<ChatMessageThread>>
If success, a list of message threads is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchCombineMessageDetail

fetchCombineMessageDetail(message): Promise<ChatMessage[]>
Gets the list of original messages included in a combined message.

A combined message contains one or more multiple original messages.
Parameters
- message: ChatMessage
  The combined message.
Returns Promise<ChatMessage[]>
The list of original messages in the message body.

Throws
A description of the exception. See ChatError.

fetchConversationsByOptions

fetchConversationsByOptions(option): Promise<ChatCursorResult<ChatConversation>>
Gets the conversations from the server by conversation filter options.
Parameters
- option: ChatConversationFetchOptions
  The conversation filter options. See ChatConversationFetchOptions.
Returns Promise<ChatCursorResult<ChatConversation>>
The retrieved list of conversations. See ChatCursorResult.

fetchConversationsFromServerWithCursor

fetchConversationsFromServerWithCursor(cursor?, pageSize?): Promise<ChatCursorResult<ChatConversation>>
Gets 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 (generally 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
- Optionalcursor: string
- OptionalpageSize: number
Returns Promise<ChatCursorResult<ChatConversation>>
The list of retrieved conversations.

Throws
A description of the exception. See ChatError.

fetchConversationsFromServerWithPage

fetchConversationsFromServerWithPage(pageSize, pageNum): Promise<ChatConversation[]>
Gets conversations from the server with pagination.
Parameters
- pageSize: number
  The number of conversations to retrieve on each page.
- pageNum: number
  The current page number, starting from 1.
Returns Promise<ChatConversation[]>
If success, the list of conversations is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchGroupAcks

fetchGroupAcks(msgId, groupId, startAckId, pageSize?): Promise<ChatCursorResult<ChatGroupMessageAck>>
Uses the pagination to get read receipts for group messages from the server.

For how to send read receipts for group messages, see sendConversationReadAck.
Parameters
- msgId: string
  The message ID.
- groupId: string
- startAckId: string
  The starting read receipt ID for query. After this parameter is set, the SDK retrieves read receipts, from the specified one, in the reverse chronological order of when the server receives them. If this parameter is set as null or an empty string, the SDK retrieves read receipts, from the latest one, in the reverse chronological order of when the server receives them.
- pageSize: number = 0
  The number of read receipts for the group message that you expect to get on each page. The value range is [1,400].
Returns Promise<ChatCursorResult<ChatGroupMessageAck>>
The list of retrieved read receipts (excluding the one with the starting ID) and the cursor for the next query.

Throws
A description of the exception. See ChatError.

fetchHistoryMessages

fetchHistoryMessages(convId, chatType, params): Promise<ChatCursorResult<ChatMessage>>
Uses the pagination to get messages in the specified conversation from the server.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- chatType: ChatConversationType
  The conversation type. See ChatConversationType.
- params: {
      direction?: ChatSearchDirection;
      pageSize?: number;
      startMsgId?: string;
  }
  - Optionaldirection?: ChatSearchDirection
  - OptionalpageSize?: number
  - OptionalstartMsgId?: string
Returns Promise<ChatCursorResult<ChatMessage>>
The list of retrieved messages (excluding the one with the starting ID) and the cursor for the next query.
Params
params
- pageSize: The number of messages that you expect to get on each page. The value range is [1,50].
- startMsgId: The starting message ID for query. After this parameter is set, the SDK retrieves messages, starting from the specified one, in the reverse chronological order of when the server receives them. If this parameter is set an empty string, the SDK retrieves messages, starting from the latest one, in the reverse chronological order of when the server receives them.
- direction: The message search direction. See ChatSearchDirection. - (Default) ChatSearchDirection.Up: Messages are retrieved in the descending order of the Unix timestamp included in them. - ChatSearchDirection.Down: Messages are retrieved in the ascending order of the Unix timestamp included in them.
Throws
A description of the exception. See ChatError.

fetchHistoryMessagesByOptions

fetchHistoryMessagesByOptions(convId, chatType, params?): Promise<ChatCursorResult<ChatMessage>>
retrieve the history message for the specified session from the server.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- chatType: ChatConversationType
  The conversation type. See ChatConversationType.
- Optionalparams: {
      cursor?: string;
      options?: ChatFetchMessageOptions;
      pageSize?: number;
  }
  options: The parameter configuration class for pulling historical messages from the server. See ChatFetchMessageOptions.
  - 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].
  - Optionalcursor?: string
  - Optionaloptions?: ChatFetchMessageOptions
  - OptionalpageSize?: number
Returns Promise<ChatCursorResult<ChatMessage>>
The list of retrieved messages (excluding the one with the starting ID) and the cursor for the next query.

Throws
A description of the exception. See ChatError.

fetchJoinedChatThreadFromServer

fetchJoinedChatThreadFromServer(cursor?, pageSize?): Promise<ChatCursorResult<ChatMessageThread>>
Uses the pagination to get the list of message threads that the current user has joined.
Parameters
- cursor: string = ''
  The position from which to start getting data. At the first method call, if you set cursor to null or an empty string, the SDK will get data in the reverse chronological order of when the user joins the message threads.
- pageSize: number = 20
  The number of message threads that you expect to get on each page. The value range is [1,400].
Returns Promise<ChatCursorResult<ChatMessageThread>>
If success, a list of message threads is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchJoinedChatThreadWithParentFromServer

fetchJoinedChatThreadWithParentFromServer(parentId, cursor?, pageSize?): Promise<ChatCursorResult<ChatMessageThread>>
Uses the pagination to get the list of message threads that the current user has joined in the specified group.

This method gets data from the server.
Parameters
- parentId: string
  The parent ID, which is the group ID.
- cursor: string = ''
  The position from which to start getting data. At the first method call, if you set cursor to null or an empty string, the SDK will get data in the reverse chronological order of when the user joins the message threads.
- pageSize: number = 20
  The number of message threads that you expect to get on each page. The value range is [1,400].
Returns Promise<ChatCursorResult<ChatMessageThread>>
If success, a list of message threads is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchLastMessageWithChatThread

fetchLastMessageWithChatThread(chatThreadIds): Promise<Map<string, ChatMessage>>
Gets the last reply in the specified message threads from the server.
Parameters
- chatThreadIds: string[]
  The list of message thread IDs to query. You can pass a maximum of 20 message thread IDs each time.
Returns Promise<Map<string, ChatMessage>>
If success, a list of last replies are returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchMembersWithChatThreadFromServer

fetchMembersWithChatThreadFromServer(chatThreadId, cursor?, pageSize?): Promise<ChatCursorResult<string>>
Uses the pagination to get a list of members in the message thread.

Each member of the group to which the message thread belongs can call this method.
Parameters
- chatThreadId: string
  The message thread ID.
- cursor: string = ''
  The position from which to start getting data. At the first method call, if you set cursor to null or an empty string, the SDK will get data in the chronological order of when members join the message thread.
- pageSize: number = 20
  The number of members that you expect to get on each page. The value range is [1,400].
Returns Promise<ChatCursorResult<string>>
If success, the list of members in a message thread is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

fetchPinnedConversationsFromServerWithCursor

fetchPinnedConversationsFromServerWithCursor(cursor?, pageSize?): Promise<ChatCursorResult<ChatConversation>>
Get 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
- Optionalcursor: string
- OptionalpageSize: number
Returns Promise<ChatCursorResult<ChatConversation>>
The list of retrieved conversations.

Throws
A description of the exception. See ChatError.

fetchPinnedMessages

fetchPinnedMessages(convId, convType, isChatThread?): Promise<ChatMessage[]>
Gets the list of pinned messages in the conversation from the server.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<ChatMessage[]>
The list of pinned messages. If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

fetchReactionDetail

fetchReactionDetail(msgId, reaction, cursor?, pageSize?): Promise<ChatCursorResult<ChatMessageReaction>>
Gets the Reaction details.
Parameters
- msgId: string
  The message ID.
- reaction: string
  The Reaction content.
- Optionalcursor: string
  The cursor position from which to start getting Reactions.
- OptionalpageSize: number
  The number of Reactions you expect to get on each page.
Returns Promise<ChatCursorResult<ChatMessageReaction>>
If success, the SDK returns the Reaction details and the cursor for the next query. The SDK returns null if all the data is fetched. If a failure occurs, an exception is thrown.

Throws
A description of the exception. See ChatError.

fetchReactionList

fetchReactionList(msgIds, groupId, chatType): Promise<Map<string, ChatMessageReaction[]>>
Gets the list of Reactions.
Parameters
- msgIds: string[]
  The message ID list.
- groupId: string
  The group ID, which is invalid only when the chat type is group chat.
- chatType: ChatMessageChatType
  The chat type.
Returns Promise<Map<string, ChatMessageReaction[]>>
If success, the Reaction list is returned; otherwise, an exception is thrown.

Throws
A description of the exception. See ChatError.

fetchSupportedLanguages

fetchSupportedLanguages(): Promise<ChatTranslateLanguage[]>
Gets all languages supported by the translation service.

Returns Promise<ChatTranslateLanguage[]>
The list of languages supported for translation.

Throws
A description of the exception. See ChatError.

getAllConversations

getAllConversations(): Promise<ChatConversation[]>
Gets all conversations from the local database.

Conversations will be first retrieved from the memory. If no conversation is found, the SDK retrieves from the local database.

Returns Promise<ChatConversation[]>
The retrieved conversations.

Throws
A description of the exception. See ChatError.

getConversation

getConversation(convId, convType, createIfNeed?, isChatThread?): Promise<undefined | ChatConversation>
Gets the conversation by conversation ID and conversation type.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- createIfNeed: boolean = true
  Whether to create a conversation if the specified conversation is not found:
  - (Default) true: Yes.
  - false: No.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
  - (Default) false: No.
  - true: Yes.
Returns Promise<undefined | ChatConversation>
The retrieved conversation object. The SDK returns null if the conversation is not found.

Throws
A description of the exception. See ChatError.

getConversationMessageCount

getConversationMessageCount(convId, convType, isChatThread?): Promise<number>
Gets the message count of the conversation.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<number>
The message count. getMessageCount

Throws
A description of the exception. See ChatError.

getConversationUnreadCount

getConversationUnreadCount(convId, convType, isChatThread?): Promise<number>
Gets the unread message count of the conversation.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<number>
The unread message count.

Throws
A description of the exception. See ChatError.

getConvMsgsWithKeyword

getConvMsgsWithKeyword(params): Promise<ChatMessage[]>
Gets messages that the specified user sends in a conversation in a certain period.

This method gets data from the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- params: {
      convId: string;
      convType: ChatConversationType;
      count?: number;
      direction?: ChatSearchDirection;
      isChatThread?: boolean;
      keywords: string;
      searchScope?: ChatMessageSearchScope;
      sender?: string;
      timestamp?: number;
  }
  - convId: string
  - convType: ChatConversationType
  - Optionalcount?: number
  - Optionaldirection?: ChatSearchDirection
  - OptionalisChatThread?: boolean
  - keywords: string
  - OptionalsearchScope?: ChatMessageSearchScope
  - Optionalsender?: string
  - Optionaltimestamp?: number
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.
Params
- convId The conversation ID.
- convType The conversation type. See ChatConversationType.
- keywords The keywords for query.
- direction The message search direction. See ChatSearchDirection.
- (Default) ChatSearchDirection.UP: Messages are retrieved in the descending order of the Unix timestamp included in them.
- ChatSearchDirection.DOWN: Messages are retrieved in the ascending order of the Unix timestamp included in them.
- timestamp The starting Unix timestamp in the message for query. The unit is millisecond. After this parameter is set, the SDK retrieves messages, starting from the specified one, according to the message search direction.
- searchScope The message search scope. See ChatMessageSearchScope. If you set this parameter as a negative value, the SDK retrieves messages, starting from the current time, in the descending order of the timestamp included in them.
- count The maximum number of messages to retrieve each time. The value range is [1,400].
- sender The user ID or group ID for retrieval. Usually, it is the conversation ID.
- isChatThread Whether the conversation is a thread conversation.
Throws
A description of the exception. See ChatError.

getLatestMessage

getLatestMessage(convId, convType, isChatThread?): Promise<undefined | ChatMessage>
Gets the latest message from the conversation.

Note

The operation does not change the unread message count. If the conversation object does not exist, this method will create it.

The SDK gets the latest message from the memory first. If no message is found, the SDK loads the message from the local database and then puts it in the memory.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<undefined | ChatMessage>
The message instance. The SDK returns undefined if the message does not exist.

Throws
A description of the exception. See ChatError.

getLatestReceivedMessage

getLatestReceivedMessage(convId, convType, isChatThread?): Promise<undefined | ChatMessage>
Gets the latest received message from the conversation.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<undefined | ChatMessage>
The message instance. The SDK returns undefined if the message does not exist.

Throws
A description of the exception. See ChatError.

getMessage

getMessage(msgId): Promise<undefined | ChatMessage>
Gets a message from the local database by message ID.
Parameters
- msgId: string
  The message ID.
Returns Promise<undefined | ChatMessage>
The message.

Throws
A description of the exception. See ChatError.

getMessagePinInfo

getMessagePinInfo(messageId): Promise<undefined | ChatMessagePinInfo>
Gets the pinning information of a message.
Parameters
- messageId: string
  The message ID.
Returns Promise<undefined | ChatMessagePinInfo>
The message pinning information. If the message does not exit or is not pinned, undefined is returned.

Throws
A description of the exception. See ChatError.

getMessages

getMessages(convId, convType, startMsgId, direction?, loadCount?, isChatThread?): Promise<ChatMessage[]>
Retrieves messages of a specified quantity in a conversation from the local database.

The retrieved messages will also be put in the conversation in the memory according to the timestamp included in them.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- startMsgId: string
  The starting message ID for query. After this parameter is set, the SDK retrieves messages, starting from the specified one, according to the message search direction. If this parameter is set an empty string, the SDK retrieves messages according to the message search direction while ignoring this parameter.
- direction: ChatSearchDirection = ChatSearchDirection.UP
  The message search direction. See ChatSearchDirection.
  - (Default) ChatSearchDirection.UP: Messages are retrieved in the descending order of the Unix timestamp included in them.
  - ChatSearchDirection.DOWN: Messages are retrieved in the ascending order of the Unix timestamp included in them.
- loadCount: number = 20
  The maximum number of messages to retrieve each time. The value range is [1,50].
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

Deprecated
2023-07-24. Use getMsgs instead.

getMessagesWithKeyword

getMessagesWithKeyword(convId, convType, keywords, direction?, timestamp?, count?, sender?, isChatThread?): Promise<ChatMessage[]>
Gets messages that the specified user sends in a conversation in a certain period.

This method gets data from the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- keywords: string
  The keywords for query.
- direction: ChatSearchDirection = ChatSearchDirection.UP
  The message search direction. See ChatSearchDirection.
  - (Default) ChatSearchDirection.UP: Messages are retrieved in the descending order of the Unix timestamp included in them.
  - ChatSearchDirection.DOWN: Messages are retrieved in the ascending order of the Unix timestamp included in them.
- timestamp: number = -1
  The starting Unix timestamp in the message for query. The unit is millisecond. After this parameter is set, the SDK retrieves messages, starting from the specified one, according to the message search direction. If you set this parameter as a negative value, the SDK retrieves messages, starting from the current time, in the descending order of the timestamp included in them.
- count: number = 20
  The maximum number of messages to retrieve each time. The value range is [1,400].
- Optionalsender: string
  The user ID or group ID for retrieval. Usually, it is the conversation ID.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

Deprecated
2023-07-24 This method is deprecated. Use getConvMsgsWithKeyword instead.

getMessagesWithMsgType

getMessagesWithMsgType(convId, convType, msgType, direction?, timestamp?, count?, sender?, isChatThread?): Promise<ChatMessage[]>
Retrieves messages of a certain type in the conversation from the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- msgType: ChatMessageType
  The message type. See ChatMessageType.
- direction: ChatSearchDirection = ChatSearchDirection.UP
  The message search direction. See ChatSearchDirection.
  - (Default) ChatSearchDirection.UP: Messages are retrieved in the descending order of the Unix timestamp included in them.
  - ChatSearchDirection.DOWN: Messages are retrieved in the ascending order of the Unix timestamp included in them.
- timestamp: number = -1
  The starting Unix timestamp in the message for query. The unit is millisecond. After this parameter is set, the SDK retrieves messages, starting from the specified one, according to the message search direction. If you set this parameter as a negative value, the SDK retrieves messages, starting from the current time, in the descending order of the timestamp included in them.
- count: number = 20
  The maximum number of messages to retrieve each time. The value range is [1,400].
- Optionalsender: string
  The user ID or group ID for retrieval. Usually, it is the conversation ID.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

Deprecated
2023-07-24. Use getMsgsWithMsgType instead.

getMessageThread

getMessageThread(msgId): Promise<undefined | ChatMessageThread>
Gets the details of the message thread from the memory.
Parameters
- msgId: string
  The message thread ID.
Returns Promise<undefined | ChatMessageThread>
If success, the details of the message thread are returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

getMessageWithTimestamp

getMessageWithTimestamp(convId, convType, startTime, endTime, direction?, count?, isChatThread?): Promise<ChatMessage[]>
Retrieves messages that are sent and received in a certain period in a conversation in the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- startTime: number
  The starting Unix timestamp for query, in milliseconds.
- endTime: number
  The ending Unix timestamp for query, in milliseconds.
- direction: ChatSearchDirection = ChatSearchDirection.UP
  The message search direction. See ChatSearchDirection.
  - (Default) ChatSearchDirection.UP: Messages are retrieved in the descending order of the Unix timestamp included in them.
  - ChatSearchDirection.DOWN: Messages are retrieved in the ascending order of the Unix timestamp included in them.
- count: number = 20
  The maximum number of messages to retrieve each time. The value range is [1,400].
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding with the ones with the starting or ending timestamp). If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

Deprecated
2023-07-24 This method is deprecated. Use getMsgWithTimestamp instead.

getMsgs

getMsgs(params): Promise<ChatMessage[]>
Retrieves messages of a specified quantity in a conversation from the local database.

The retrieved messages will also be put in the conversation in the memory according to the timestamp included in them.

note If the conversation object does not exist, this method will create it.
Parameters
- params: {
      convId: string;
      convType: ChatConversationType;
      direction?: ChatSearchDirection;
      isChatThread?: boolean;
      loadCount?: number;
      startMsgId: string;
  }
  - convId: string
  - convType: ChatConversationType
  - Optionaldirection?: ChatSearchDirection
  - OptionalisChatThread?: boolean
  - OptionalloadCount?: number
  - startMsgId: string
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.
Params
Throws
A description of the exception. See ChatError.

getMsgsWithKeyword

getMsgsWithKeyword(params): Promise<ChatMessage[]>
Retrieves messages with keywords from the local database.
Parameters
- params: {
      direction?: ChatSearchDirection;
      from?: string;
      keywords: string;
      maxCount?: number;
      searchScope?: ChatMessageSearchScope;
      timestamp?: number;
  }
  - Optionaldirection?: ChatSearchDirection
  - Optionalfrom?: string
  - keywords: string
  - OptionalmaxCount?: number
  - OptionalsearchScope?: ChatMessageSearchScope
  - Optionaltimestamp?: number
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

getMsgsWithMsgType

getMsgsWithMsgType(params): Promise<ChatMessage[]>
Retrieves messages of a certain type in the conversation from the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- params: {
      convId: string;
      convType: ChatConversationType;
      count?: number;
      direction?: ChatSearchDirection;
      isChatThread?: boolean;
      msgType: ChatMessageType;
      sender?: string;
      timestamp?: number;
  }
  - convId: string
  - convType: ChatConversationType
  - Optionalcount?: number
  - Optionaldirection?: ChatSearchDirection
  - OptionalisChatThread?: boolean
  - msgType: ChatMessageType
  - Optionalsender?: string
  - Optionaltimestamp?: number
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.
Params
Throws
A description of the exception. See ChatError.

getMsgWithTimestamp

getMsgWithTimestamp(params): Promise<ChatMessage[]>
Retrieves messages that are sent and received in a certain period in a conversation in the local database.

note If the conversation object does not exist, this method will create it.
Parameters
- params: {
      convId: string;
      convType: ChatConversationType;
      count?: number;
      direction?: ChatSearchDirection;
      endTime: number;
      isChatThread?: boolean;
      startTime: number;
  }
  - convId: string
  - convType: ChatConversationType
  - Optionalcount?: number
  - Optionaldirection?: ChatSearchDirection
  - endTime: number
  - OptionalisChatThread?: boolean
  - startTime: number
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding with the ones with the starting or ending timestamp). If no message is obtained, an empty list is returned.
Params
Throws
A description of the exception. See ChatError.

getPinnedMessages

getPinnedMessages(convId, convType, isChatThread?): Promise<ChatMessage[]>
Gets the pinned messages in a local conversation.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<ChatMessage[]>
The list of pinned messages. If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

getReactionList

getReactionList(msgId): Promise<ChatMessageReaction[]>
Gets the list of Reactions from a message.
Parameters
- msgId: string
  The message ID.
Returns Promise<ChatMessageReaction[]>
If success, the Reaction list is returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

getThreadConversation

getThreadConversation(convId, createIfNeed?): Promise<undefined | ChatConversation>
Gets the thread conversation by conversation ID.
Parameters
- convId: string
  The conversation ID.
- createIfNeed: boolean = true
  Whether to create a conversation if the specified conversation is not found:
  - (Default) true: Yes.
  - false: No.
Returns Promise<undefined | ChatConversation>
The retrieved conversation object. The SDK returns null if the conversation is not found.

Throws
A description of the exception. See ChatError.

getUnreadCount

getUnreadCount(): Promise<number>
Gets the count of the unread messages.

Returns Promise<number>
The count of the unread messages.

Throws
A description of the exception. See ChatError.

groupAckCount

groupAckCount(msgId): Promise<undefined | number>
Gets the number of members that have read the group message.
Parameters
- msgId: string
  The message ID.
Returns Promise<undefined | number>
If success, the SDK returns the number of members that have read the group message; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

importMessages

importMessages(messages): Promise<void>
Imports messages to the local database.

You can only import messages that you sent or received.
Parameters
- messages: ChatMessage[]
  The messages to import.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

insertMessage

insertMessage(message): Promise<void>
Inserts a message to the conversation in the local database.

For example, when a notification messages is received, a message can be constructed and written to the conversation. If the message to insert already exits (msgId or localMsgId is existed), the insertion fails.

The message will be inserted based on the Unix timestamp included in it. Upon message insertion, the SDK will automatically update attributes of the conversation, including latestMessage.
Parameters
- message: ChatMessage
  The message to be inserted.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

joinChatThread

joinChatThread(chatThreadId): Promise<ChatMessageThread>
Joins a message thread.

Each member of the group where the message thread belongs can call this method.

In a multi-device login scenario, note the following:
- The devices will receive the ChatMultiDeviceEventListener.onThreadEvent callback.
- You can listen for message thread events by setting ChatMultiDeviceEventListener.
Parameters
- chatThreadId: string
  The message thread ID.
Returns Promise<ChatMessageThread>
If success, the message thread details ChatMessageThread are returned; otherwise, an exception will be thrown.

Throws
A description of the exception. See ChatError.

leaveChatThread

leaveChatThread(chatThreadId): Promise<void>
Leaves a message thread.

Each member in the message thread can call this method.

In a multi-device login scenario, note the following:
- The devices will receive the ChatMultiDeviceEventListener.onThreadEvent callback.
- You can listen for message thread events by setting ChatMultiDeviceEventListener.
Parameters
- chatThreadId: string
  The ID of the message thread that the current user wants to leave.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

markAllConversationsAsRead

markAllConversationsAsRead(): Promise<void>
Marks all conversations as read.

This method is for the local conversations only.

Returns Promise<void>
Throws
A description of the exception. See ChatError.

markAllMessagesAsRead

markAllMessagesAsRead(convId, convType, isChatThread?): Promise<void>
Marks all messages as read.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

markMessageAsRead

markMessageAsRead(convId, convType, msgId, isChatThread?): Promise<void>
Marks a message as read.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- msgId: string
  The message ID.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

modifyMessageBody

modifyMessageBody(msgId, body): Promise<ChatMessage>
Modifies a message.

After this method is called to modify a message, both the local message and the message on the server are modified.

This method can only modify a text message in one-to-one chats or group chats, but not in chat rooms.
Parameters
- msgId: string
  The ID of the message to modify.
- body: ChatMessageBody
  The modified text message body. See ChatTextMessageBody.
Returns Promise<ChatMessage>
The modified message. See ChatMessageBody.

Throws
A description of the exception. See ChatError.

pinConversation

pinConversation(convId, isPinned): Promise<void>
Sets whether to pin a conversation.
Parameters
- convId: string
  The conversation ID.
- isPinned: boolean
  Whether to pin a conversation:
  - true：Yes.
  - false: No. The conversation is unpinned.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

pinMessage

pinMessage(messageId): Promise<void>
Pins a message.
Parameters
- messageId: string
  The message ID.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

recallMessage

recallMessage(msgId): Promise<void>
Recalls the sent message.
Parameters
- msgId: string
  The message ID.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

removeAllMessageListener

removeAllMessageListener(): void
Removes all message listeners.

Returns void

removeConversationFromServer

removeConversationFromServer(convId, convType, isDeleteMessage?): Promise<void>
Deletes the specified conversation and its historical messages from the server.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- isDeleteMessage: boolean = true
  Whether to delete the historical messages with the conversation.
  - (Default) true: Yes.
  - false: No.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

removeMemberWithChatThread

removeMemberWithChatThread(chatThreadId, memberId): Promise<void>
Removes a member from the message thread.

Only the owner or admins of the group where the message thread belongs and the message thread creator can call this method.

The removed member will receive the ChatMessageEventListener.onChatMessageThreadUserRemoved callback.

You can listen for message thread events by setting ChatMessageEventListener.
Parameters
- chatThreadId: string
  The message thread ID.
- memberId: string
  The user ID of the member to be removed from the message thread.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

removeMessageListener

removeMessageListener(listener): void
Removes the message listener.
Parameters
- listener: ChatMessageEventListener
  The message listener to remove.
Returns void

removeMessagesFromServerWithMsgIds

removeMessagesFromServerWithMsgIds(convId, convType, msgIds, isChatThread?): Promise<void>
Deletes messages from the conversation (from both local storage and server).

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation Type.
- msgIds: string[]
  The IDs of messages to delete from the current conversation.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

removeMessagesFromServerWithTimestamp

removeMessagesFromServerWithTimestamp(convId, convType, timestamp, isChatThread?): Promise<void>
Deletes messages from the conversation (from both local storage and server).

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation Type.
- timestamp: number
  The message timestamp in millisecond. The messages with the timestamp smaller than the specified one will be deleted.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

removeReaction

removeReaction(reaction, msgId): Promise<void>
Deletes a Reaction.
Parameters
- reaction: string
  The Reaction to delete.
- msgId: string
  The message ID.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

reportMessage

reportMessage(msgId, tag, reason): Promise<void>
Reports an inappropriate message.
Parameters
- msgId: string
  The ID of the message to report.
- tag: string
  The tag of the inappropriate message. You need to type a custom tag, like porn or ad.
- reason: string
  The reporting reason. You need to type a specific reason.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

resendMessage

resendMessage(message, callback): Promise<void>
Resends a message.
Parameters
- message: ChatMessage
  The message object to be resent.
- callback: ChatMessageStatusCallback
  The listener that listens for message changes.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

searchMsgFromDB

searchMsgFromDB(keywords, timestamp?, maxCount?, from?, direction?): Promise<ChatMessage[]>
Retrieves messages with keywords in a conversation from the local database.
Parameters
- keywords: string
  The keywords for query.
- timestamp: number = -1
  The starting Unix timestamp in the message for query. The unit is millisecond. After this parameter is set, the SDK retrieves messages, starting from the specified one, according to the message search direction. If you set this parameter as a negative value, the SDK retrieves messages, starting from the current time, in the descending order of the timestamp included in them.
- maxCount: number = 20
  The maximum number of messages to retrieve each time. The value range is [1,400].
- from: string = ''
  The user ID or group ID for retrieval. Usually, it is the conversation ID.
- direction: ChatSearchDirection = ChatSearchDirection.UP
  The message search direction. See ChatSearchDirection. - (Default) ChatSearchDirection.Up: Messages are retrieved in the descending order of the Unix timestamp included in them. - ChatSearchDirection.Down: Messages are retrieved in the ascending order of the Unix timestamp included in them.
Returns Promise<ChatMessage[]>
The list of retrieved messages (excluding the one with the starting timestamp). If no message is obtained, an empty list is returned.

Throws
A description of the exception. See ChatError.

Deprecated
2024-04-22. Use getMsgsWithKeyword instead.

sendConversationReadAck

sendConversationReadAck(convId): Promise<void>
Sends the conversation read receipt to the server.

Note
- This method is valid only for one-to-one conversations.
- After this method is called, the sever will set the message status from unread to read.
- The SDK triggers the ChatMessageEventListener.onConversationRead callback on the client of the message sender, notifying that the messages are read. This also applies to multi-device scenarios.
Parameters
- convId: string
  The conversation ID.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

sendGroupMessageReadAck

sendGroupMessageReadAck(msgId, groupId, opt?): Promise<void>
Sends the group message receipt to the server.

Note
- This method takes effect only after you set ChatOptions.requireAck and ChatMessage.needGroupAck as true.
- This method applies to group messages only. To send a read receipt for a one-to-one chat message, you can call sendMessageReadAck; to send a conversation read receipt, you can call sendConversationReadAck.
Parameters
- msgId: string
  The message ID.
- groupId: string
  The group ID.
- Optionalopt: {
  content: string;
  }
  The extension information, which is a custom keyword that specifies a custom action or command.
  - content: string
Returns Promise<void>
Throws
A description of the exception. See ChatError.

sendMessage

sendMessage(message, callback?): Promise<void>
Sends a message.

Note
- For a voice or image message or a message with an attachment, the SDK will automatically upload the attachment.
- You can determine whether to upload the attachment to the chat sever by setting ChatOptions.
Parameters
- message: ChatMessage
  The message object to be sent. Ensure that you set this parameter.
- Optionalcallback: ChatMessageStatusCallback
  The listener that listens for message changes.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

sendMessageReadAck

sendMessageReadAck(message): Promise<void>
Sends the read receipt to the server.

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

Note

This method takes effect only when you set ChatOptions.requireAck as true.

To send a group message read receipt, you can call sendGroupMessageReadAck.

We recommend that you call sendConversationReadAck when opening the chat page. In other cases, you can call this method to reduce the number of method calls.
Parameters
- message: ChatMessage
  The message for which the read receipt is to be sent.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

setConversationExtension

setConversationExtension(convId, convType, ext, isChatThread?): Promise<void>
Sets the extension information of the conversation.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- ext: {
  [key: string]: string | number | boolean;
  }
  The extension information. This parameter must be key-value type.
  - [key: string]: string | number | boolean
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>

setNativeListener

setNativeListener(event): void
Parameters
- event: NativeEventEmitter
Returns void
Overrides BaseManager.setNativeListener

translateMessage

translateMessage(msg, languages): Promise<ChatMessage>
Translates a text message.
Parameters
- msg: ChatMessage
  The text message to translate.
- languages: string[]
  The target languages.
Returns Promise<ChatMessage>
The translation.

Throws
A description of the exception. See ChatError.

unpinMessage

unpinMessage(messageId): Promise<void>
Unpins a message.
Parameters
- messageId: string
  The message ID.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

updateChatThreadName

updateChatThreadName(chatThreadId, newName): Promise<void>
Changes the name of the message thread.

Only the owner or admins of the group where the message thread belongs and the message thread creator can call this method.

Each member of the group to which the message thread belongs will receive the ChatMessageEventListener.onChatMessageThreadUpdated callback.

You can listen for message thread events by setting ChatMessageEventListener.
Parameters
- chatThreadId: string
  The message thread ID.
- newName: string
  The new message thread name. It can contain a maximum of 64 characters.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

updateConversationMessage

updateConversationMessage(convId, convType, msg, isChatThread?): Promise<void>
Updates a message in the local database.

After you modify a message, the message ID remains unchanged and the SDK automatically updates properties of the conversation, like latestMessage.

note If the conversation object does not exist, this method will create it.
Parameters
- convId: string
  The conversation ID.
- convType: ChatConversationType
  The conversation type. See ChatConversationType.
- msg: ChatMessage
  The ID of the message to update.
- isChatThread: boolean = false
  Whether the conversation is a thread conversation.
Returns Promise<void>
Throws
A description of the exception. See ChatError.

updateMessage

updateMessage(message): Promise<ChatMessage>
Updates the local message.

The message will be updated both in the memory and local database.
Parameters
- message: ChatMessage
Returns Promise<ChatMessage>
The updated message.

Throws
A description of the exception. See ChatError.

`Protected` `Static`_callMethod

_callMethod<T>(method, args?): Promise<T>
Type Parameters
- T
Parameters
- method: string
- Optionalargs: {}
Returns Promise<T>
Inherited from BaseManager._callMethod

`Protected` `Static`checkErrorFromResult

checkErrorFromResult(result): void
Parameters
- result: any
Returns void
Inherited from BaseManager.checkErrorFromResult

`Protected` `Static`handleGroupFileCallback

handleGroupFileCallback(methodName, self, groupId, filePath, callback?): void
Parameters
- methodName: string
- self: BaseManager
- groupId: string
- filePath: string
- Optionalcallback: ChatGroupFileStatusCallback
Returns void
Inherited from BaseManager.handleGroupFileCallback

`Protected` `Static`handleMessageCallback

handleMessageCallback(methodName, self, message, callback?): void
Parameters
- methodName: string
- self: BaseManager
- message: ChatMessage
- Optionalcallback: ChatMessageStatusCallback
Returns void
Inherited from BaseManager.handleMessageCallback

Class ChatManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ChatManager

Properties

Protected Optional_eventEmitter

StaticTAG

Methods

addMessageListener

Parameters

Returns void

addReaction

Parameters

Returns Promise<void>

Throws

addRemoteAndLocalConversationsMark

Parameters

Returns Promise<void>

Throws

createChatThread

Parameters

Returns Promise<ChatMessageThread>

Throws

deleteAllMessageAndConversation

Parameters

Returns Promise<void>

Throws

deleteConversation

Parameters

Returns Promise<void>

Throws

deleteConversationAllMessages

Parameters

Returns Promise<void>

Throws

deleteMessage

Parameters

Returns Promise<void>

Throws

deleteMessagesBeforeTimestamp

Parameters

Returns Promise<void>

Throws

deleteMessagesWithTimestamp

Parameters

endTs: number

startTs: number

Returns Promise<void>

Params

Throws

deleteRemoteAndLocalConversationsMark

Parameters

Returns Promise<void>

Throws

destroyChatThread

Parameters

Returns Promise<void>

Throws

downloadAttachment

Parameters

Returns Promise<void>

Throws

downloadAttachmentInCombine

Parameters

Returns Promise<void>

Throws

downloadThumbnail

Parameters

Returns Promise<void>

Throws

downloadThumbnailInCombine

Parameters

Returns Promise<void>

Throws

fetchAllConversations

`Protected` `Optional`_eventEmitter

`Static`TAG

`Optional`direction?: ChatSearchDirection

`Optional`pageSize?: number

`Optional`startMsgId?: string

`Optional`cursor?: string

`Optional`options?: ChatFetchMessageOptions

`Optional`pageSize?: number