IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMMessageManagerabstract

Public Member Functions

abstract void addAdvancedMsgListener (V2TIMAdvancedMsgListener listener)
 
abstract void removeAdvancedMsgListener (V2TIMAdvancedMsgListener listener)
 
abstract V2TIMMessage createTextMessage (String text)
 
abstract V2TIMMessage createTextAtMessage (String text, List< String > atUserList)
 
abstract V2TIMMessage createCustomMessage (byte[] data)
 
abstract V2TIMMessage createCustomMessage (byte[] data, String description, byte[] extension)
 
abstract V2TIMMessage createImageMessage (String imagePath)
 
abstract V2TIMMessage createSoundMessage (String soundPath, int duration)
 
abstract V2TIMMessage createVideoMessage (String videoFilePath, String type, int duration, String snapshotPath)
 
abstract V2TIMMessage createFileMessage (String filePath, String fileName)
 
abstract V2TIMMessage createLocationMessage (String desc, double longitude, double latitude)
 
abstract V2TIMMessage createFaceMessage (int index, byte[] data)
 
abstract V2TIMMessage createMergerMessage (List< V2TIMMessage > messageList, String title, List< String > abstractList, String compatibleText)
 
abstract V2TIMMessage createForwardMessage (V2TIMMessage message)
 
abstract V2TIMMessage createTargetedGroupMessage (V2TIMMessage message, List< String > receiverList)
 
abstract V2TIMMessage createAtSignedGroupMessage (V2TIMMessage message, List< String > atUserList)
 
abstract String sendMessage (V2TIMMessage message, String receiver, String groupID, int priority, boolean onlineUserOnly, V2TIMOfflinePushInfo offlinePushInfo, V2TIMSendCallback< V2TIMMessage > callback)
 
abstract void setC2CReceiveMessageOpt (List< String > userIDList, int opt, V2TIMCallback callback)
 
abstract void getC2CReceiveMessageOpt (List< String > userIDList, V2TIMValueCallback< List< V2TIMReceiveMessageOptInfo >> callback)
 
abstract void setGroupReceiveMessageOpt (String groupID, int opt, V2TIMCallback callback)
 
abstract void setAllReceiveMessageOpt (int opt, int startHour, int startMinute, int startSecond, long duration, V2TIMCallback callback)
 
abstract void setAllReceiveMessageOpt (int opt, long startTimeStamp, long duration, V2TIMCallback callback)
 
abstract void getAllReceiveMessageOpt (V2TIMValueCallback< V2TIMReceiveMessageOptInfo > callback)
 
abstract void getC2CHistoryMessageList (String userID, int count, V2TIMMessage lastMsg, V2TIMValueCallback< List< V2TIMMessage >> callback)
 
abstract void getGroupHistoryMessageList (String groupID, int count, V2TIMMessage lastMsg, V2TIMValueCallback< List< V2TIMMessage >> callback)
 
abstract void getHistoryMessageList (V2TIMMessageListGetOption option, V2TIMValueCallback< List< V2TIMMessage >> callback)
 
abstract void revokeMessage (V2TIMMessage msg, V2TIMCallback callback)
 
abstract void modifyMessage (V2TIMMessage msg, V2TIMCompleteCallback< V2TIMMessage > callback)
 
abstract void deleteMessageFromLocalStorage (V2TIMMessage msg, V2TIMCallback callback)
 
abstract void deleteMessages (List< V2TIMMessage > messages, V2TIMCallback callback)
 
abstract void clearC2CHistoryMessage (String userID, V2TIMCallback callback)
 
abstract void clearGroupHistoryMessage (String groupID, V2TIMCallback callback)
 
abstract String insertGroupMessageToLocalStorage (V2TIMMessage msg, String groupID, String sender, V2TIMValueCallback< V2TIMMessage > callback)
 
abstract String insertC2CMessageToLocalStorage (V2TIMMessage msg, String userID, String sender, V2TIMValueCallback< V2TIMMessage > callback)
 
abstract void findMessages (List< String > messageIDList, V2TIMValueCallback< List< V2TIMMessage >> callback)
 
abstract void searchLocalMessages (V2TIMMessageSearchParam searchParam, V2TIMValueCallback< V2TIMMessageSearchResult > callback)
 
abstract void searchCloudMessages (V2TIMMessageSearchParam searchParam, V2TIMValueCallback< V2TIMMessageSearchResult > callback)
 
abstract void sendMessageReadReceipts (List< V2TIMMessage > messageList, V2TIMCallback callback)
 
abstract void getMessageReadReceipts (List< V2TIMMessage > messageList, V2TIMValueCallback< List< V2TIMMessageReceipt >> callback)
 
abstract void getGroupMessageReadMemberList (V2TIMMessage message, int filter, long nextSeq, int count, V2TIMValueCallback< V2TIMGroupMessageReadMemberList > callback)
 
abstract void setMessageExtensions (V2TIMMessage message, List< V2TIMMessageExtension > extensions, V2TIMValueCallback< List< V2TIMMessageExtensionResult >> callback)
 
abstract void getMessageExtensions (V2TIMMessage message, V2TIMValueCallback< List< V2TIMMessageExtension >> callback)
 
abstract void deleteMessageExtensions (V2TIMMessage message, List< String > keys, V2TIMValueCallback< List< V2TIMMessageExtensionResult >> callback)
 
abstract void addMessageReaction (V2TIMMessage message, String reactionID, V2TIMCallback callback)
 
abstract void removeMessageReaction (V2TIMMessage message, String reactionID, V2TIMCallback callback)
 
abstract void getMessageReactions (List< V2TIMMessage > messageList, int maxUserCountPerReaction, V2TIMValueCallback< List< V2TIMMessageReactionResult >> callback)
 
abstract void getAllUserListOfMessageReaction (V2TIMMessage message, String reactionID, int nextSeq, int count, V2TIMValueCallback< V2TIMMessageReactionUserResult > callback)
 
abstract void translateText (List< String > sourceTextList, String sourceLanguage, String targetLanguage, V2TIMValueCallback< HashMap< String, String >> callback)
 
abstract void pinGroupMessage (String groupID, V2TIMMessage message, boolean isPinned, V2TIMCallback callback)
 
abstract void getPinnedGroupMessageList (String groupID, V2TIMValueCallback< List< V2TIMMessage >> callback)
 
abstract void markC2CMessageAsRead (String userID, V2TIMCallback callback)
 
abstract void markGroupMessageAsRead (String groupID, V2TIMCallback callback)
 
abstract void markAllMessageAsRead (V2TIMCallback callback)
 

Member Function Documentation

◆ addAdvancedMsgListener()

abstract void addAdvancedMsgListener ( V2TIMAdvancedMsgListener  listener)
abstract

1.1 Add an event listener for advanced messages

◆ removeAdvancedMsgListener()

abstract void removeAdvancedMsgListener ( V2TIMAdvancedMsgListener  listener)
abstract

1.2 Remove the event listener for advanced messages

◆ createTextMessage()

abstract V2TIMMessage createTextMessage ( String  text)
abstract

2.1 Create a text message

◆ createTextAtMessage()

abstract V2TIMMessage createTextAtMessage ( String  text,
List< String >  atUserList 
)
abstract

2.2 Create a text message with the mentioning(@) feature

You can mention someone only in group chats.

Parameters
atUserListList of @ target users. To @all, please pass in the V2TIMGroupAtInfo.AT_ALL_TAG constant string. For example, if you want the current text message to @denny, @lucy, and @all, pass in ["denny","lucy",V2TIMGroupAtInfo.AT_ALL_TAG] for atUserList.
Attention
The following are use limits for atUserList:
  • The maximum number of @ target users is 30 by default. If this limit is exceeded, message sending will fail.
  • The total number of users specified by atUserList cannot exceed the default maximum number, including the case of @all.
  • AVChatRoom groups do not support @ messages.

◆ createCustomMessage() [1/2]

abstract V2TIMMessage createCustomMessage ( byte []  data)
abstract

2.3 Create a custom message

◆ createCustomMessage() [2/2]

abstract V2TIMMessage createCustomMessage ( byte []  data,
String  description,
byte []  extension 
)
abstract

2.4 Create a custom message and set offline push information

Parameters
descriptionCustom message description to be displayed for offline push
extensionExtension field for offline push

◆ createImageMessage()

abstract V2TIMMessage createImageMessage ( String  imagePath)
abstract

2.5 Create an image message (image size limit: 28 MB)

◆ createSoundMessage()

abstract V2TIMMessage createSoundMessage ( String  soundPath,
int  duration 
)
abstract

2.6 Create a voice message (voice size limit: 28 MB)

Parameters
durationVoice duration, in seconds

◆ createVideoMessage()

abstract V2TIMMessage createVideoMessage ( String  videoFilePath,
String  type,
int  duration,
String  snapshotPath 
)
abstract

2.7 Create a video message (video size limit: 100 MB)

Parameters
typeVideo type, such as mp4 and mov
durationVideo duration, in seconds
snapshotPathVideo cover image path

◆ createFileMessage()

abstract V2TIMMessage createFileMessage ( String  filePath,
String  fileName 
)
abstract

2.8 Create a file message (file size limit: 100 MB)

◆ createLocationMessage()

abstract V2TIMMessage createLocationMessage ( String  desc,
double  longitude,
double  latitude 
)
abstract

2.9 Create a location message

◆ createFaceMessage()

abstract V2TIMMessage createFaceMessage ( int  index,
byte []  data 
)
abstract

2.10 Create an emoji message

The Chat SDK does not provide an emoji package. Developers can use index to store the indexes of the emojis they have in their emoji packages. Alternatively, they can directly use data to store emoji binary data and the string key. Either way, developers can customize emojis. The Chat SDK is only responsible for passing them through.

Parameters
indexEmoji index
dataCustom data

◆ createMergerMessage()

abstract V2TIMMessage createMergerMessage ( List< V2TIMMessage messageList,
String  title,
List< String >  abstractList,
String  compatibleText 
)
abstract

2.11 Create a combined message (supported only in 5.2.210 and later versions)

A typical combined message looks like this on the UI:

|Chat History of Vinson and Lynx | – title

|Vinson: When is the new version of SDK scheduled to go online? | – abstract1

|Lynx: Next Monday. The specific time depends on the system test result in these two days. | – abstract2

|Vinson: OK | – abstract3

The chat UI usually displays only the title and abstract of the combined message. The complete combined message list will be displayed only when the user clicks the combined message on the UI.

You can create a combined message (V2TIMMessage) for multiple messages to be forwarded and call the sendMessage API to send the combined message. The procedure is as follows:

1. Call createMergerMessage to create a combined message V2TIMMessage.

2. Call sendMessage to send the forward V2TIMMessage.

The procedure for parsing a combined message received is as follows:

1. Obtain mergerElem via V2TIMMessage.

2. Obtain title and abstractList via mergerElem for UI display.

3. When the user clicks the combined message on the UI, call downloadMessageList to get the list of forwarded messages.

Parameters
messageListMessage list (Up to 300 messages are supported. The message object must be in the V2TIM_MSG_STATUS_SEND_SUCC status. The message type cannot be V2TIMGroupTipsElem.)
titleSource of the combined message, for example, "Chat History of Vinson and Lynx" and "xxx group chat history"
abstractListCombined message abstract list (supports up to 5 abstracts, each containing a maximum of 100 characters). You can use different abstract formats for different message types. For example, for a text message, the format can be "sender:text" format. For an image message, the format can be "sender:[image]". For a file message, the format can be in the "sender:[file]".
compatibleTextText to be displayed if the SDK version does not support combined messages. This parameter cannot be null.

◆ createForwardMessage()

abstract V2TIMMessage createForwardMessage ( V2TIMMessage  message)
abstract

2.12 Create a forward message (supported only in 5.2.210 and later versions)

If you need to forward a message, you cannot directly call the sendMessage API to send the original message. Instead, you need to call createForwardMessage to create a forward message first and send it.

Parameters
messageMessage object to be forwarded. The message status must be V2TIM_MSG_STATUS_SEND_SUCC. The message type cannot be V2TIMGroupTipsElem.
Returns
Forward message object. The elem content is the same as the original message.

◆ createTargetedGroupMessage()

abstract V2TIMMessage createTargetedGroupMessage ( V2TIMMessage  message,
List< String >  receiverList 
)
abstract

2.13 Create a targeted group message(supported only in 6.0 and later versions)

If you need to send a message to a specified group member list within a group, you can create a targeted group message. Only the specified group member can receive the targeted group message.

Parameters
messageOriginal message object
receiverListMessage receivers
Returns
Targeted group message object
Attention
Please note:
  • The original message object does not support group @ message.
  • You can specify up to 50 message receivers.
  • Targeted group messages are not supported in community or avchatroom groups.
  • Targeted group messages will not be counted as unread messages.

◆ createAtSignedGroupMessage()

abstract V2TIMMessage createAtSignedGroupMessage ( V2TIMMessage  message,
List< String >  atUserList 
)
abstract

2.14 Create a group message that mentions others(supported only in 7.0 and later versions)

If you need to send a group message with the mentioning (@) feature, use this API to create a message.

Parameters
messageOriginal message object
atUserListList of @ target users. To @all, please pass in the V2TIMGroupAtInfo.AT_ALL_TAG constant string. For example, if you want the current message to @denny, @lucy, and @all, pass in @["denny", @"lucy", V2TIMGroupAtInfo.AT_ALL_TAG] for atUserList.
Returns
Group @ message object
Attention
The following are use limits for atUserList:
  • The maximum number of @ target users is 30 by default. If this limit is exceeded, message sending will fail.
  • The total number of users specified by atUserList cannot exceed the default maximum number, including the case of @all.
  • AVChatRoom groups do not support @ messages.

◆ sendMessage()

abstract String sendMessage ( V2TIMMessage  message,
String  receiver,
String  groupID,
int  priority,
boolean  onlineUserOnly,
V2TIMOfflinePushInfo  offlinePushInfo,
V2TIMSendCallback< V2TIMMessage callback 
)
abstract

3.1 Send an advanced message (advanced version: provides the features of specifying message priorities and push information)

Parameters
messageMessage object to be sent, which needs to be created via the corresponding message creation API
receiverMessage recipient's userID. For a one-to-one message, you only need to specify this field.
groupIDTarget group ID. For a group chat message, you only need to specify this field.
priorityMessage priorities. This field is valid only for group chat messages. You are advised to set higher priorities for important messages (such as red packet and gift messages) and set lower priorities for frequent but unimportant messages (such as like messages).
onlineUserOnlyWhether the message can be received only by online users. If this field is set to true, the message will not appear in the recipient's historical message list. This field is often used to implement less important notifications such as typing indicators. This field is not supported by audio-video groups (AVChatRoom).
offlinePushInfoTitle and content for offline push
Returns
Unique ID of the message
Attention
  • In v6.0 or later, you can specify both groupID and receiver, and the message will be sent to the specified user in the group. If you want to send a message to multiple users in a group, you need to call the createTargetedGroupMessage API to create a targeted group message first.
  • Before setting the offlinePushInfo field, you need to enable push via V2TIMOfflinePushManager. After push is enabled, all messages except custom messages will be pushed by default.
  • If you want to push custom messages as well, set the desc field in offlinePushInfo so that the information specified by desc will be displayed by default during push.
  • Audio-video groups (AVChatRoom) do not support the onlineUserOnly field. You need to set onlineUserOnly to false for audio-video groups (AVChatRoom).
  • If onlineUserOnly is set to true, the message is an online message and is not counted as an unread message.

◆ setC2CReceiveMessageOpt()

abstract void setC2CReceiveMessageOpt ( List< String >  userIDList,
int  opt,
V2TIMCallback  callback 
)
abstract

4.1 Set the one-to-one message receiving option for specified users (batch setting supported)

Supported only in 5.3.425 and later versions.

Attention
Notes:
  • This API supports batch setting. You can use the userIDList field to specify up to 30 users for batch setting.
  • This API can be called for up to 5 times per second.
Parameters
optThere are three message receiving options: V2TIMMessage.V2TIM_RECEIVE_MESSAGE: messages will be received when the user is online, and push notifications will be received when the user is offline. V2TIMMessage.V2TIM_NOT_RECEIVE_MESSAGE: no message will be received. V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE: messages will be received when the user is online, and no push notification will be received when the user is offline.

◆ getC2CReceiveMessageOpt()

abstract void getC2CReceiveMessageOpt ( List< String >  userIDList,
V2TIMValueCallback< List< V2TIMReceiveMessageOptInfo >>  callback 
)
abstract

4.2 Query the one-to-one message receiving option for specified users

Supported only in 5.3.425 and later versions.

◆ setGroupReceiveMessageOpt()

abstract void setGroupReceiveMessageOpt ( String  groupID,
int  opt,
V2TIMCallback  callback 
)
abstract

4.3 Set the group message receiving option

Parameters
optThere are three message receiving options: V2TIMMessage.V2TIM_RECEIVE_MESSAGE: messages will be received when the user is online, and push notifications will be received when the user is offline. V2TIMMessage.V2TIM_NOT_RECEIVE_MESSAGE: no group message will be received. V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE: messages will be received when the user is online, and no push notification will be received when the user is offline. V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT: messages will be received when the user is online, and no push notification will be received when the user is offline but except @ message.

◆ setAllReceiveMessageOpt() [1/2]

abstract void setAllReceiveMessageOpt ( int  opt,
int  startHour,
int  startMinute,
int  startSecond,
long  duration,
V2TIMCallback  callback 
)
abstract

4.4 Set message receiving option for all conversations,supported only in 7.4 and later versions.

Parameters
optThere are two message receiving options for you to choose: V2TIMMessage.V2TIM_RECEIVE_MESSAGE:messages will be received when the user is online, and notifications will be received when the user is offline. V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE:messages will be received when the user is online, and no push notification will be received when the user is offline.(you can use this to mute group chat notifications)
startHour(0 - 23) The starting hour of the muting duration
startMinute(0 - 59) The starting minute of the muting duration
startSecond(0 - 59) The starting second of the muting duration
duration(0 - 24*60*60) The muting duration in seconds
Attention
Notes.
  • If duration is less than 24*60*60, group chat notifications will be muted starting from "startHour:startMinute:startSecond" every day and unmuted after the specified duration elapses.
  • If the duration is 24*60*61 or longer, group chat notifications will be muted indefinitely starting from startHour:startMinute:startSecond of the day when the API is called.

◆ setAllReceiveMessageOpt() [2/2]

abstract void setAllReceiveMessageOpt ( int  opt,
long  startTimeStamp,
long  duration,
V2TIMCallback  callback 
)
abstract

4.5 Set message receiving option for all conversations,supported only in 7.4 and later versions.

Parameters
optThere are two message receiving options for you to choose: V2TIMMessage.V2TIM_RECEIVE_MESSAGE:messages will be received when the user is online, and notifications will be received when the user is offline. V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE:messages will be received when the user is online, and no push notification will be received when the user is offline.(you can use this to mute group chat notifications)
startTimeStampThe start time of muting, UTC timestamp, unit: second
durationThe muting duration in seconds

◆ getAllReceiveMessageOpt()

abstract void getAllReceiveMessageOpt ( V2TIMValueCallback< V2TIMReceiveMessageOptInfo callback)
abstract

4.6 Get the message receiving option for all conversations,supported only in 7.4 and later versions.

◆ getC2CHistoryMessageList()

abstract void getC2CHistoryMessageList ( String  userID,
int  count,
V2TIMMessage  lastMsg,
V2TIMValueCallback< List< V2TIMMessage >>  callback 
)
abstract

5.1 Get historical one-to-one messages

Parameters
countNumber of messages pulled at a time. The value of this field cannot be too large; otherwise, the pulling speed is affected. We recommend that you pull 20 messages at a time.
lastMsgStart message for message pulling. If null is passed in, the newest message of the conversation will be considered as the start message.
Attention
Notes:
  • If the login API is not called,calling this API will not return any historical messages.
  • If login failed, calling this API will return local historical messages.
  • If login is successful and the network is disconnected, calling this API will return local historical messages.
  • If login is successful and the network is normal, after this API is called, cloud historical messages will be pulled first, which will be merged with local historical messages before being returned.

◆ getGroupHistoryMessageList()

abstract void getGroupHistoryMessageList ( String  groupID,
int  count,
V2TIMMessage  lastMsg,
V2TIMValueCallback< List< V2TIMMessage >>  callback 
)
abstract

5.2 Get historical group messages

Parameters
countNumber of messages pulled at a time. The value of this field cannot be too large; otherwise, the pulling speed is affected. We recommend that you pull 20 messages at a time.
lastMsgStart message for message pulling. If null is passed in, the newest message of the conversation will be considered as the start message.
Attention
Notes:
  • If the login API is not called,calling this API will not return any historical messages.
  • If login failed, calling this API will return local historical messages.
  • If login is successful and the network is disconnected, calling this API will return local historical messages.
  • If login is successful and the network is normal, after this API is called, cloud historical messages will be pulled first, which will be merged with local historical messages before being returned.
  • Only meeting groups (Meeting) support pulling historical messages of members before they join the groups. For audio-video groups (AVChatRoom), messages are not saved to the roaming and local databases, and therefore this API does not take effect.

◆ getHistoryMessageList()

abstract void getHistoryMessageList ( V2TIMMessageListGetOption  option,
V2TIMValueCallback< List< V2TIMMessage >>  callback 
)
abstract

5.3 Get historical messages (advanced API)

Parameters
optionMessage pulling option, which can be set to pull older or newer messages from local storage or the cloud
Attention
Notes:
  • If the login API is not called,calling this API will not return any historical messages.
  • If login failed, calling this API will return local historical messages.
  • If login is successful and the network is disconnected, calling this API will return local historical messages.
  • If login is successful and the network is connected, when the option param is set to pull cloud historical messages, calling this API will first request cloud historical messages, and then merge them with local historical messages before returning.
  • Only meeting groups (Meeting) support pulling historical messages of members before they join the groups. For audio-video groups (AVChatRoom), messages are not saved to the roaming and local databases, and therefore this API does not take effect.

◆ revokeMessage()

abstract void revokeMessage ( V2TIMMessage  msg,
V2TIMCallback  callback 
)
abstract

5.4 Recall messages

Attention
Notes:
  • By default, you can recall only messages that are sent within 2 minutes. You can customize the time limit for message recall via the console (Feature Configuration -> Login and Message -> Message Recall Settings).
  • Only common messages sent in one-to-one chats and group chats can be recalled. You cannot recall messages that can be received only by online users (onlineUserOnly is set to true).
  • If the sender recalls a message, the recipient will receive the V2TIMAdvancedMsgListener -> onRecvMessageRevoked callback.
  • This API is available for all group types, including audio-video groups (AVChatRoom) and community groups, in 7.4 and later versions.
  • In one-to-one chats, messages can only be recalled by their senders.
  • In group chats, not only the sender can recall their own message, but administrators or group owners can also recall messages sent by other group members through this API.

◆ modifyMessage()

abstract void modifyMessage ( V2TIMMessage  msg,
V2TIMCompleteCallback< V2TIMMessage callback 
)
abstract

5.5 Modify a message

Attention
Notes:
  • If the message is modified successfully, both the sender and recipients (of one-to-one or group messages) will receive the onRecvMessageModified callback.
  • While a message is being modified, if another user successfully modified it, the ERR_SDK_MSG_MODIFY_CONFLICT error will be returned upon completion.
  • The latest message object will be returned regardless of whether a message is modified successfully.

◆ deleteMessageFromLocalStorage()

abstract void deleteMessageFromLocalStorage ( V2TIMMessage  msg,
V2TIMCallback  callback 
)
abstract

5.6 Delete a message from local storage

Attention
Messages can only be deleted locally. After a message is deleted, the SDK marks the message as deleted locally, and the message can no longer be pulled via getHistoryMessage. However, after the app is uninstalled and reinstalled, the local delete marker of the message will get lost, and the message can still be pulled via getHistoryMessage.

◆ deleteMessages()

abstract void deleteMessages ( List< V2TIMMessage messages,
V2TIMCallback  callback 
)
abstract

5.7 Delete messages from local storage and the cloud

Attention
In addition to deleting messages from the local storage (deleteMessageFromLocalStorage), this API simultaneously deletes messages from the cloud, and the deleted messages cannot be recovered. Please note that:
  • Up to 50 messages can be deleted at a time.
  • The messages to be deleted at a time must belong to the same conversation.
  • This API can be called only once per second.
  • If the account has pulled these messages from other devices, the messages will still be stored on those devices after this API is called to delete them. That is, the operation of message deletion cannot be synchronized across multiple devices.

◆ clearC2CHistoryMessage()

abstract void clearC2CHistoryMessage ( String  userID,
V2TIMCallback  callback 
)
abstract

5.8 Clear chat history with a user from local storage and the cloud (without deleting the conversation)

Supported only in 5.4.666 and later versions.

Attention
Notes:
  • When messages in a conversation are deleted from local storage, they are deleted simultaneously from the server.

◆ clearGroupHistoryMessage()

abstract void clearGroupHistoryMessage ( String  groupID,
V2TIMCallback  callback 
)
abstract

5.9 Clear chat history of a group from local storage and the cloud (without deleting the conversation)

Supported only in 5.4.666 and later versions.

Attention
Notes:
  • When messages in a conversation are deleted from local storage, they are also deleted from the server.

◆ insertGroupMessageToLocalStorage()

abstract String insertGroupMessageToLocalStorage ( V2TIMMessage  msg,
String  groupID,
String  sender,
V2TIMValueCallback< V2TIMMessage callback 
)
abstract

5.10 Add a message to the group message list

This API is mainly used to insert informative messages in a group chat, such as "you have exited the group". Such messages are shown to the local user but not sent to others. In this sense, insertGroupMessageToLocalStorage() is sendMessage() API with the message delivery feature disabled.

Returns
msgID Unique ID of a message
Attention
Messages saved via this API are saved only to the local storage and will get lost after the app is uninstalled.

◆ insertC2CMessageToLocalStorage()

abstract String insertC2CMessageToLocalStorage ( V2TIMMessage  msg,
String  userID,
String  sender,
V2TIMValueCallback< V2TIMMessage callback 
)
abstract

5.11 Insert a message in a one-to-one chat

This API is mainly used to insert informative messages in a one-to-one, such as "you have successfully sent the message". Such messages are shown to the local user but not sent to the remote user. In this sense, insertGroupMessageToLocalStorage() is sendMessage() API with the message delivery feature disabled.

Returns
msgID Unique ID of a message
Attention
Messages saved via this API are saved only to the local storage and will get lost after the app is uninstalled.

◆ findMessages()

abstract void findMessages ( List< String >  messageIDList,
V2TIMValueCallback< List< V2TIMMessage >>  callback 
)
abstract

5.12 Query local messages in a specified conversation by messageID

Parameters
messageIDListMessage ID list

◆ searchLocalMessages()

abstract void searchLocalMessages ( V2TIMMessageSearchParam  searchParam,
V2TIMValueCallback< V2TIMMessageSearchResult callback 
)
abstract

5.13 Search for local messages (supported only in Chat Premium 5.4.666 and later versions)

Parameters
searchParamMessage search parameter. For details, see the definition of V2TIMMessageSearchParam.

◆ searchCloudMessages()

abstract void searchCloudMessages ( V2TIMMessageSearchParam  searchParam,
V2TIMValueCallback< V2TIMMessageSearchResult callback 
)
abstract

5.14 Search for cloud messages (supported only in 7.3 and later versions)

Parameters
searchParamMessage search parameter. For details, see the definition of V2TIMMessageSearchParam.
Attention
  • This feature is a value-added service of Chat. Please refer to the pricing details for more information.
  • If you have not activated this service, calling the interface will return error code 60020.

◆ sendMessageReadReceipts()

abstract void sendMessageReadReceipts ( List< V2TIMMessage messageList,
V2TIMCallback  callback 
)
abstract

5.15 Send read receipts to the message sender (supported only in Chat Premium 6.1 and later versions)

Attention
Notes:
  • To send a read receipt for a group message, you need to turn on the corresponding feature in the Chat console.
  • The messages in messageList must be in the same conversation.
  • After the API is called successfully, the sender's message unread count will not change. Instead, the sender will receive the onRecvMessageReadReceipts callback, which indicates whether the message has been read.

◆ getMessageReadReceipts()

abstract void getMessageReadReceipts ( List< V2TIMMessage messageList,
V2TIMValueCallback< List< V2TIMMessageReceipt >>  callback 
)
abstract

5.16 Get read receipts for messages sent (Supported only in Chat Premium 6.1 and later versions)

Attention
Notes:

◆ getGroupMessageReadMemberList()

abstract void getGroupMessageReadMemberList ( V2TIMMessage  message,
int  filter,
long  nextSeq,
int  count,
V2TIMValueCallback< V2TIMGroupMessageReadMemberList callback 
)
abstract

5.17 Get group members who have read a group message (Supported only in Chat Premium 6.1 and later)

Parameters
messagegroup message
filterWhether to get members who have or who have not read the message. Valid values: V2TIMMessage.V2TIM_GROUP_MESSAGE_READ_MEMBERS_FILTER_READ, V2TIMMessage.V2TIM_GROUP_MESSAGE_READ_MEMBERS_FILTER_UNREAD
nextSeqPulling-by-page cursor. It is set to 0 when the information is pulled for the first time. The value of this field in the callback for the current paginated pulling is passed in for the next pull.
countNumber of members (max 100) pulled per page.
Attention
Notes:
  • Please go to the console and turn on the corresponding switch before using this feature.

◆ setMessageExtensions()

abstract void setMessageExtensions ( V2TIMMessage  message,
List< V2TIMMessageExtension extensions,
V2TIMValueCallback< List< V2TIMMessageExtensionResult >>  callback 
)
abstract

5.18 Set message extensions (supported only in 6.7 and later versions)

Parameters
messageThe target message must be sent successfully and its supportMessageExtension field must be set to true before sending. In addition, AVChatRoom message do not support this feature.
extensionsThe existing message extensions will be updated, and non-existing message extensions will be added directly.
Attention
  • You need to buy Premium Edition to use this feature. And you need to go to the IM console to enable this feature.
  • The extension key supports a maximum of 100 bytes, the extension value supports a maximum of 1KB, a maximum of 20 extensions can be set at a time, and a maximum of 300 extensions can be set for a single message.
  • If multiple users set the same extension key at the same time, only the first user can execute it successfully. The other users will receive the 23001 error code and the newest extension information, and can try again afterward.
  • We strongly recommend that different users set different extension keys, so that conflict will not appear in most scenarios. For example, you can use your userID as an extension key for voting, solitaire, and questionnaires.

◆ getMessageExtensions()

abstract void getMessageExtensions ( V2TIMMessage  message,
V2TIMValueCallback< List< V2TIMMessageExtension >>  callback 
)
abstract

5.19 Get message extensions (supported only in 6.7 and later versions)

◆ deleteMessageExtensions()

abstract void deleteMessageExtensions ( V2TIMMessage  message,
List< String >  keys,
V2TIMValueCallback< List< V2TIMMessageExtensionResult >>  callback 
)
abstract

5.20 Delete message extensions (supported only in 6.7 and later versions)

Parameters
keysMessage extension key list. If this is null, it means to delete all extensions of the message.
Attention
  • If multiple users delete the same extension key at the same time, only the first user can execute it successfully. The other users will receive the 23001 error code and the newest extension information, and can try again afterward.

◆ addMessageReaction()

abstract void addMessageReaction ( V2TIMMessage  message,
String  reactionID,
V2TIMCallback  callback 
)
abstract

5.21 Add a message reaction (can be used for emoji response) (supported only in 7.4 and later versions)

Emoji response function refers to the interaction response to a message through emoji symbols. We can see the number of responses and the list of responders for each emoji.

Currently, there are two common styles of message response display:

Style one:

-------------------------—

| lucy, happy birthday! |

-------------------------—

| 😄 1 💐 2 👍🏻 10 |

-------------------------—

Style two:

------------------------------------------------------—

| lucy, happy birthday! |

------------------------------------------------------—

| 😁 bob 💐olivia 🎂david |

| 👍🏻 denny、james、lucy、linda、thomas and other 10 people |

-------------------------------------------------------—

When the user clicks on an emoji, it will jump to the emoji response detail interface:

| 😄 | 💐 | 👍🏻 |

| bob | olivia | lucy |

| ... | ... | denny |

| ... | ... | ... |

You can pull a list of users who responded with an emoji by page.

You can implement emoji response capabilities using the following SDK APIs:

1、Call addMessageReaction to add an emoji reaction to a message. If it succeeds, the current user will be added to the response list for that emoji.

2、Call removeMessageReaction to delete an added emoji reaction. If it succeeds, the current user will be removed from the response list for that emoji.

3、Call getMessageReactions to get the emoji reactions of multiple messages. The number of users who responded with each emoji and the information of the first N users (10 by default) will be returned.

4、Call getAllUserListOfMessageReaction to get the information of all users who responded with the emojis by page.

5、Listen to the onRecvMessageReactionsChanged callback to receive notifications about the change of emoji response. The callback will return the latest response information, including the total number of users who responded with each emoji and the information of the first N users.

Parameters
reactionIDMessage reaction ID. In the emoji response scenario, reactionID is the emojiID. A single message supports up to 10 reactions, and a single reaction supports up to 100 users.
Attention
  • You need to buy the Premium edition to use this feature.
  • If the total count of reactions in a single message exceeds the maximum limit, the interface will report ERR_SVR_MSG_REACTION_COUNT_LIMIT error.
  • If the total count of users in a single reaction exceeds the maximum limit, the interface will report ERR_SVR_MSG_REACTION_USER_COUNT_LIMIT error.
  • If the current user is already in the specified emoji's response list, the interface will report the ERR_SVR_MSG_REACTION_ALREADY_CONTAIN_USER error.

◆ removeMessageReaction()

abstract void removeMessageReaction ( V2TIMMessage  message,
String  reactionID,
V2TIMCallback  callback 
)
abstract

5.22 Remove a message reaction (supported only in 7.4 and later versions)

Attention
  • You need to buy Premium Edition to use this feature.
  • If the reaction does not exist, the interface will report ERR_SVR_MSG_REACTION_NOT_EXISTS error.
  • If the current user is not in the specified emoji's response list, the interface will report the ERR_SVR_MSG_REACTION_NOT_CONTAIN_USER error.

◆ getMessageReactions()

abstract void getMessageReactions ( List< V2TIMMessage messageList,
int  maxUserCountPerReaction,
V2TIMValueCallback< List< V2TIMMessageReactionResult >>  callback 
)
abstract

5.23 Get message reactions (supported only in 7.4 and later versions)

Parameters
messageListMessage list, supports up to 20 messages at a time, which must belong to the same conversation.
maxUserCountPerReactionThe value range is 【0,10】. Every reaction only supports returning the first 10 user profile at most. If you need more user profile, you can call the getAllUserListOfMessageReaction interface to pull in pages.
Attention
  • You need to buy Premium Edition to use this feature.

◆ getAllUserListOfMessageReaction()

abstract void getAllUserListOfMessageReaction ( V2TIMMessage  message,
String  reactionID,
int  nextSeq,
int  count,
V2TIMValueCallback< V2TIMMessageReactionUserResult callback 
)
abstract

5.24 Get a list of users who responded with an emoji (supported only in 7.4 and later versions)

Parameters
messageMessage object
reactionIDMessage reaction ID
nextSeqThe pulling-by-page cursor. Pass 0 for the first time, and pass the nextSeq returned by succ for subsequent pagination.
countThe maximum count of users fetched per page, up to 100.
Attention
  • You need to buy Premium Edition to use this feature.

◆ translateText()

abstract void translateText ( List< String >  sourceTextList,
String  sourceLanguage,
String  targetLanguage,
V2TIMValueCallback< HashMap< String, String >>  callback 
)
abstract

5.25 Translate text message.

Parameters
sourceTextListTexts to be translated.
sourceLanguageSource language. You can pass the specific language or "auto". "auto" means identifying the source language automatically. If you set it to nil, "auto" will be filled as default.
targetLanguageTarget language. Multi languages are supported, like: English-"en", Simplified Chinese-"zh", French-"fr", German-"ge" and so on. For more languages, please refer to this documentation: Language support.
callbackTranslated result callback. The key represents the source text and value represents target text.

◆ pinGroupMessage()

abstract void pinGroupMessage ( String  groupID,
V2TIMMessage  message,
boolean  isPinned,
V2TIMCallback  callback 
)
abstract

5.26 Set the group message to the top(supported only in Chat Premium 7.9 and later versions)

Parameters
groupIDGroup ID
isPinnedWhether to pin it to the top
Attention
  • The maximum number of messages that can be pinned is 10.
  • This interface is used to pin and cancel pinned group messages. If the number of pinned messages exceeds the limit, the SDK will return error code 10070.

◆ getPinnedGroupMessageList()

abstract void getPinnedGroupMessageList ( String  groupID,
V2TIMValueCallback< List< V2TIMMessage >>  callback 
)
abstract

5.27 Get the list of pinned group messages(supported only in Chat Premium 7.9 and later versions)

Parameters
groupIDGroup ID
Attention
  • This interface is used to obtain the pinned message list. If the pinned message has expired, it will not be returned.

◆ markC2CMessageAsRead()

abstract void markC2CMessageAsRead ( String  userID,
V2TIMCallback  callback 
)
abstract

5.28 Mark all messages of a one-to-one conversation as read (This is to be deprecated. Please call cleanConversationUnreadMessageCount instead.)

Attention
Notes:
  • After the API is successfully called, your unread count will be cleared to 0, and the remote user will receive the onRecvC2CReadReceipt callback, which will contain the time when the messages were marked as read.
  • If userID is null, all one-to-one messages will be marked as read. This is only supported in 5.8 and later versions.

◆ markGroupMessageAsRead()

abstract void markGroupMessageAsRead ( String  groupID,
V2TIMCallback  callback 
)
abstract

5.29 Mark all messages of a group chat as read (This is to be deprecated. Please call cleanConversationUnreadMessageCount instead.)

Attention
Notes:
  • After the API is successfully called, your unread count will be cleared to 0.
  • If groupID is null, all group messages will be marked as read. This is only supported in 5.8 and later versions.

◆ markAllMessageAsRead()

abstract void markAllMessageAsRead ( V2TIMCallback  callback)
abstract

5.30 Mark all messages as read (This is to be deprecated. Please call cleanConversationUnreadMessageCount instead.)