Public Member Functions
virtual	~V2TIMMessageManager ()

virtual void	AddAdvancedMsgListener (V2TIMAdvancedMsgListener *listener)=0

virtual void	RemoveAdvancedMsgListener (V2TIMAdvancedMsgListener *listener)=0

virtual V2TIMMessage	CreateTextMessage (const V2TIMString &text)=0

virtual V2TIMMessage	CreateTextAtMessage (const V2TIMString &text, const V2TIMStringVector &atUserList)=0

virtual V2TIMMessage	CreateCustomMessage (const V2TIMBuffer &data)=0

virtual V2TIMMessage	CreateCustomMessage (const V2TIMBuffer &data, const V2TIMString &description, const V2TIMString &extension)=0

virtual V2TIMMessage	CreateImageMessage (const V2TIMString &imagePath)=0

virtual V2TIMMessage	CreateSoundMessage (const V2TIMString &soundPath, uint32_t duration)=0

virtual V2TIMMessage	CreateVideoMessage (const V2TIMString &videoFilePath, const V2TIMString &type, uint32_t duration, const V2TIMString &snapshotPath)=0

virtual V2TIMMessage	CreateFileMessage (const V2TIMString &filePath, const V2TIMString &fileName)=0

virtual V2TIMMessage	CreateLocationMessage (const V2TIMString &desc, double longitude, double latitude)=0

virtual V2TIMMessage	CreateFaceMessage (uint32_t index, const V2TIMBuffer &data)=0

virtual V2TIMMessage	CreateMergerMessage (const V2TIMMessageVector &messageList, const V2TIMString &title, const V2TIMStringVector &abstractList, const V2TIMString &compatibleText)=0

virtual V2TIMMessage	CreateForwardMessage (const V2TIMMessage &message)=0

virtual V2TIMMessage	CreateTargetedGroupMessage (const V2TIMMessage &message, const V2TIMStringVector &receiverList)=0

virtual V2TIMMessage	CreateAtSignedGroupMessage (const V2TIMMessage &message, const V2TIMStringVector &atUserList)=0

virtual V2TIMString	SendMessage (V2TIMMessage &message, const V2TIMString &receiver, const V2TIMString &groupID, V2TIMMessagePriority priority, bool onlineUserOnly, const V2TIMOfflinePushInfo &offlinePushInfo, V2TIMSendCallback *callback)=0

virtual void	SetC2CReceiveMessageOpt (const V2TIMStringVector &userIDList, V2TIMReceiveMessageOpt opt, V2TIMCallback *callback)=0

virtual void	GetC2CReceiveMessageOpt (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMReceiveMessageOptInfoVector > *callback)=0

virtual void	SetGroupReceiveMessageOpt (const V2TIMString &groupID, V2TIMReceiveMessageOpt opt, V2TIMCallback *callback)=0

virtual void	SetAllReceiveMessageOpt (V2TIMReceiveMessageOpt opt, int32_t startHour, int32_t startMinute, int32_t startSecond, uint32_t duration, V2TIMCallback *callback)=0

virtual void	SetAllReceiveMessageOpt (V2TIMReceiveMessageOpt opt, uint32_t startTimeStamp, uint32_t duration, V2TIMCallback *callback)=0

virtual void	GetAllReceiveMessageOpt (V2TIMValueCallback< V2TIMReceiveMessageOptInfo > *callback)=0

virtual void	GetHistoryMessageList (const V2TIMMessageListGetOption &option, V2TIMValueCallback< V2TIMMessageVector > *callback)=0

virtual void	RevokeMessage (const V2TIMMessage &message, V2TIMCallback *callback)=0

virtual void	ModifyMessage (const V2TIMMessage &message, V2TIMCompleteCallback< V2TIMMessage > *callback)=0

virtual void	DeleteMessages (const V2TIMMessageVector &messages, V2TIMCallback *callback)=0

virtual void	ClearC2CHistoryMessage (const V2TIMString &userID, V2TIMCallback *callback)=0

virtual void	ClearGroupHistoryMessage (const V2TIMString &groupID, V2TIMCallback *callback)=0

virtual V2TIMString	InsertGroupMessageToLocalStorage (V2TIMMessage &message, const V2TIMString &groupID, const V2TIMString &sender, V2TIMValueCallback< V2TIMMessage > *callback)=0

virtual V2TIMString	InsertC2CMessageToLocalStorage (V2TIMMessage &message, const V2TIMString &userID, const V2TIMString &sender, V2TIMValueCallback< V2TIMMessage > *callback)=0

virtual void	FindMessages (const V2TIMStringVector &messageIDList, V2TIMValueCallback< V2TIMMessageVector > *callback)=0

virtual void	SearchLocalMessages (const V2TIMMessageSearchParam &searchParam, V2TIMValueCallback< V2TIMMessageSearchResult > *callback)=0

virtual void	SearchCloudMessages (const V2TIMMessageSearchParam &searchParam, V2TIMValueCallback< V2TIMMessageSearchResult > *callback)=0

virtual void	SendMessageReadReceipts (const V2TIMMessageVector &messageList, V2TIMCallback *callback)=0

virtual void	GetMessageReadReceipts (const V2TIMMessageVector &messageList, V2TIMValueCallback< V2TIMMessageReceiptVector > *callback)=0

virtual void	GetGroupMessageReadMemberList (const V2TIMMessage &message, V2TIMGroupMessageReadMembersFilter filter, uint64_t nextSeq, uint32_t count, V2TIMValueCallback< V2TIMGroupMessageReadMemberList > *callback)=0

virtual void	SetMessageExtensions (const V2TIMMessage &message, const V2TIMMessageExtensionVector &extensions, V2TIMValueCallback< V2TIMMessageExtensionResultVector > *callback)=0

virtual void	GetMessageExtensions (const V2TIMMessage &message, V2TIMValueCallback< V2TIMMessageExtensionVector > *callback)=0

virtual void	DeleteMessageExtensions (const V2TIMMessage &message, const V2TIMStringVector &keys, V2TIMValueCallback< V2TIMMessageExtensionResultVector > *callback)=0

virtual void	AddMessageReaction (const V2TIMMessage &message, const V2TIMString &reactionID, V2TIMCallback *callback)=0

virtual void	RemoveMessageReaction (const V2TIMMessage &message, const V2TIMString &reactionID, V2TIMCallback *callback)=0

virtual void	GetMessageReactions (const V2TIMMessageVector &messageList, uint32_t maxUserCountPerReaction, V2TIMValueCallback< V2TIMMessageReactionResultVector > *callback)=0

virtual void	GetAllUserListOfMessageReaction (const V2TIMMessage &message, const V2TIMString &reactionID, uint32_t nextSeq, uint32_t count, V2TIMValueCallback< V2TIMMessageReactionUserResult > *callback)=0

virtual void	TranslateText (const V2TIMStringVector &sourceTextList, const V2TIMString &sourceLanguage, const V2TIMString &targetLanguage, V2TIMValueCallback< V2TIMStringToV2TIMStringMap > *callback)=0

virtual void	MarkC2CMessageAsRead (const V2TIMString &userID, V2TIMCallback *callback)=0

virtual void	MarkGroupMessageAsRead (const V2TIMString &groupID, V2TIMCallback *callback)=0

virtual void	MarkAllMessageAsRead (V2TIMCallback *callback)=0

Constructor & Destructor Documentation

◆ ~V2TIMMessageManager()

virtual ~V2TIMMessageManager ( )

inlinevirtual

Member Function Documentation

◆ AddAdvancedMsgListener()

virtual void AddAdvancedMsgListener ( V2TIMAdvancedMsgListener * listener )

pure virtual

1.1 Add an event listener for advanced messages

◆ RemoveAdvancedMsgListener()

virtual void RemoveAdvancedMsgListener ( V2TIMAdvancedMsgListener * listener )

pure virtual

1.2 Remove the event listener for advanced messages

◆ CreateTextMessage()

virtual V2TIMMessage CreateTextMessage ( const V2TIMString & text )

pure virtual

2.1 Create a text message

◆ CreateTextAtMessage()

virtual V2TIMMessage CreateTextAtMessage	(	const V2TIMString &	text,
		const V2TIMStringVector &	atUserList
	)

pure virtual

2.2 Create a text message with the @ notification feature（This interface is deprecated, recommended to use the CreateAtSignedGroupMessage interface）

Notification messages are only applicable to messages sent in the group.

Parameters

atUserList List of @ target users. To @all, please pass in the kImSDK_MesssageAtALL constant string. For example, if you want the current text message to @denny, @lucy, and @all, pass in ["denny","lucy",kImSDK_MesssageAtALL] 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 do not support sending @ messages.

◆ CreateCustomMessage() [1/2]

virtual V2TIMMessage CreateCustomMessage ( const V2TIMBuffer & data )

pure virtual

2.3 Create a custom message

◆ CreateCustomMessage() [2/2]

virtual V2TIMMessage CreateCustomMessage	(	const V2TIMBuffer &	data,
		const V2TIMString &	description,
		const V2TIMString &	extension
	)

pure virtual

2.4 Create a custom message and set offline push information

Parameters

description	Custom message description information to be displayed in text during offline push
extension	Extension field information during offline push

◆ CreateImageMessage()

virtual V2TIMMessage CreateImageMessage ( const V2TIMString & imagePath )

pure virtual

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

◆ CreateSoundMessage()

virtual V2TIMMessage CreateSoundMessage	(	const V2TIMString &	soundPath,
		uint32_t	duration
	)

pure virtual

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

Parameters

duration Voice duration, in seconds

◆ CreateVideoMessage()

virtual V2TIMMessage CreateVideoMessage	(	const V2TIMString &	videoFilePath,
		const V2TIMString &	type,
		uint32_t	duration,
		const V2TIMString &	snapshotPath
	)

pure virtual

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

Parameters

type	Video type, such as mp4 and mov
duration	Video duration, in seconds
snapshotPath	Video cover image path

◆ CreateFileMessage()

virtual V2TIMMessage CreateFileMessage	(	const V2TIMString &	filePath,
		const V2TIMString &	fileName
	)

pure virtual

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

◆ CreateLocationMessage()

virtual V2TIMMessage CreateLocationMessage	(	const V2TIMString &	desc,
		double	longitude,
		double	latitude
	)

pure virtual

2.9 Create a location message

◆ CreateFaceMessage()

virtual V2TIMMessage CreateFaceMessage	(	uint32_t	index,
		const V2TIMBuffer &	data
	)

pure virtual

2.10 Create an emoji message

The IM 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 IM SDK is only responsible for passing them through.

Parameters

index	Emoji index
data	Custom data

◆ CreateMergerMessage()

virtual V2TIMMessage CreateMergerMessage	(	const V2TIMMessageVector &	messageList,
		const V2TIMString &	title,
		const V2TIMStringVector &	abstractList,
		const V2TIMString &	compatibleText
	)

pure virtual

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

Usually when we receive a combined message, the chat screen will look like this:

|Chat History of Vinson and Lynx | – title (Title)

|Vinson: When is the new version of SDK scheduled to go online? | – abstract1 (Digest information 1)

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

|Vinson: OK | – abstract3 (Digest information 3)

The chat UI usually displays only the title and digest information of the combined message, and 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 message 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 a user clicks the digest information on the UI, call downloadMessageList to get the list of forwarded messages.

Parameters

messageList	Message 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.)
title	Source of the combined message, for example, "Chat History of Vinson and Lynx" and "xxx group chat history"
abstractList	Combined message digest list (supports up to 5 digests, each containing a maximum of 100 characters) You can set digest information in different formats for different message types, for example: For a text message, the digest can be in the "sender:text" format. For an image message, the digest can be in the "sender:[image]" format. For a file message, the digest can be in the "sender:[file]" format.
compatibleText	Combined messages are compatible with text. SDKs of early versions do not support combined messages, and they will send a text message with the content compatibleText by default. The parameter cannot be empty string.

◆ CreateForwardMessage()

virtual V2TIMMessage CreateForwardMessage ( const V2TIMMessage & message )

pure virtual

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

message Message 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()

virtual V2TIMMessage CreateTargetedGroupMessage	(	const V2TIMMessage &	message,
		const V2TIMStringVector &	receiverList
	)

pure virtual

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

message	Original message object
receiverList	Message receivers

Returns: Targeted group message object

Attention

Please note：

The original message object does not support group @ message.
The message receiver list supports up to 50.
The targeted group message cannot be sent in community group and avchatroom group.
The targeted group message will not be counted into the count of unread message for a group conversation.

◆ CreateAtSignedGroupMessage()

virtual V2TIMMessage CreateAtSignedGroupMessage	(	const V2TIMMessage &	message,
		const V2TIMStringVector &	atUserList
	)

pure virtual

2.14 Create a @ signed group message（supported only in 7.0 and later versions）

If you need to send a group message with @ notification feature, you can create a @ signed group message.

Parameters

message	Original message object
atUserList	List of @ target users. To @all, please pass in the kImSDK_MesssageAtALL constant string. For example, if you want the current message to @denny, @lucy, and @all, pass in @["denny", @"lucy", kImSDK_MesssageAtALL] 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 do not support sending @ messages.

◆ SendMessage()

virtual V2TIMString SendMessage	(	V2TIMMessage &	message,
		const V2TIMString &	receiver,
		const V2TIMString &	groupID,
		V2TIMMessagePriority	priority,
		bool	onlineUserOnly,
		const V2TIMOfflinePushInfo &	offlinePushInfo,
		V2TIMSendCallback *	callback
	)

pure virtual

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

Parameters

message	Message object to be sent, which needs to be created via the corresponding message creation API
receiver	Message recipient's userID. For a one-to-one message, you only need to specify this field.
groupID	Target group ID For a group chat message, you only need to specify this field.
priority	Message 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).
onlineUserOnly	Whether the message can be received only by online users. If this field is set to true, the message cannot be pulled in recipient historical message pulling. This field is often used to implement weak notification features such as "The other party is typing" or unimportant notifications in the group. This field is not supported by audio-video groups (AVChatRoom).
offlinePushInfo	Title and voice carried when the message pushing offline.

Returns: Unique ID of the message

Attention

Targeted group messages are supported in version 6.0 and later. If groupID and receiver are set at the same time, the message will be sent to the specified receiver in the group. If you want to send message to multiple receivers in a group, you need to call CreateTargetedGroupMessage API to create a targeted group message with multiple receivers before sending.
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()

virtual void SetC2CReceiveMessageOpt	(	const V2TIMStringVector &	userIDList,
		V2TIMReceiveMessageOpt	opt,
		V2TIMCallback *	callback
	)

pure virtual

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

opt There 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()

virtual void GetC2CReceiveMessageOpt	(	const V2TIMStringVector &	userIDList,
		V2TIMValueCallback< V2TIMReceiveMessageOptInfoVector > *	callback
	)

pure virtual

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

Supported only in 5.3.425 and later versions.

◆ SetGroupReceiveMessageOpt()

virtual void SetGroupReceiveMessageOpt	(	const V2TIMString &	groupID,
		V2TIMReceiveMessageOpt	opt,
		V2TIMCallback *	callback
	)

pure virtual

4.3 Set the group message receiving option

◆ SetAllReceiveMessageOpt() [1/2]

virtual void SetAllReceiveMessageOpt	(	V2TIMReceiveMessageOpt	opt,
		int32_t	startHour,
		int32_t	startMinute,
		int32_t	startSecond,
		uint32_t	duration,
		V2TIMCallback *	callback
	)

pure virtual

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

Parameters

opt	There are two message receiving options for you to choose: V2TIMReceiveMessageOpt.V2TIM_RECEIVE_MESSAGE：messages will be received when the user is online, and notifications will be received when the user is offline. V2TIMReceiveMessageOpt.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.（It can be used to implement the user's do not disturb function）
startHour	(0 - 23) The hour field of the start time for do not disturb function
startMinute	(0 - 59) The minute field of the start time for do not disturb function
startSecond	(0 - 59) The second field of the start time for do not disturb function
duration	(0 - 246060) Duration for do not disturb function, unit: second

Attention

Notes.

When the value of duration is less than 24*60*60, it can be used to implement "Repeated Do Not Disturb" which means the Message Do Not Disturb starts from the time point represented by "startHour:startMinute:startSecond" every day and durations for specified interval represented by this field.
When the duration value is not less than 24*60*60, it can be used to achieve "Permanent Do Not Disturb" which means the Message Do Not Disturb starts from the time point represented by "startHour:startMinute:startSecond" and keep going for ever.

◆ SetAllReceiveMessageOpt() [2/2]

virtual void SetAllReceiveMessageOpt	(	V2TIMReceiveMessageOpt	opt,
		uint32_t	startTimeStamp,
		uint32_t	duration,
		V2TIMCallback *	callback
	)

pure virtual

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

Parameters

opt	There are two message receiving options for you to choose: V2TIMReceiveMessageOpt.V2TIM_RECEIVE_MESSAGE：messages will be received when the user is online, and notifications will be received when the user is offline. V2TIMReceiveMessageOpt.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.（It can be used to implement the user's do not disturb function）
startTimeStamp	The start time for do not disturb function, UTC timestamp, unit: second
duration	Duration for do not disturb function, unit: second

◆ GetAllReceiveMessageOpt()

virtual void GetAllReceiveMessageOpt ( V2TIMValueCallback< V2TIMReceiveMessageOptInfo > * callback )

pure virtual

4.5 Get all Message receiving option，supported only in 7.4 and later versions.

◆ GetHistoryMessageList()

virtual void GetHistoryMessageList	(	const V2TIMMessageListGetOption &	option,
		V2TIMValueCallback< V2TIMMessageVector > *	callback
	)

pure virtual

5.1 Get historical messages (advanced API)

Parameters

option Message pulling option, which can be set to pull older or newer messages from local storage or the cloud

Attention

Notes:

If the login interface is not called，calling this interface will not return any historical messages.
If the login is failed, calling this interface will return local historical messages.
If the login is successful and the network is disconnected, calling this interface will return local historical messages.
If the login is successful and the network is connected, when the option param is set to pull cloud historical messages, calling this interface 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()

virtual void RevokeMessage	(	const V2TIMMessage &	message,
		V2TIMCallback *	callback
	)

pure virtual

5.2 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. 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, only the sender can recall their own messages through this API.
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()

virtual void ModifyMessage	(	const V2TIMMessage &	message,
		V2TIMCompleteCallback< V2TIMMessage > *	callback
	)

pure virtual

5.3 Modify message

Attention

Notes：

If the message is modified successfully, both the user and the peer user (C2C) or group member (Group) will receive the onRecvMessageModified callback.
If the message has been modified by others during the process of modifying the message, the completion will return ERR_SDK_MSG_MODIFY_CONFLICT error.
Completion returns the latest message object regardless of whether the message is modified successfully or failed.

◆ DeleteMessages()

virtual void DeleteMessages	(	const V2TIMMessageVector &	messages,
		V2TIMCallback *	callback
	)

pure virtual

5.4 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()

virtual void ClearC2CHistoryMessage	(	const V2TIMString &	userID,
		V2TIMCallback *	callback
	)

pure virtual

5.5 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()

virtual void ClearGroupHistoryMessage	(	const V2TIMString &	groupID,
		V2TIMCallback *	callback
	)

pure virtual

5.6 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()

virtual V2TIMString InsertGroupMessageToLocalStorage	(	V2TIMMessage &	message,
		const V2TIMString &	groupID,
		const V2TIMString &	sender,
		V2TIMValueCallback< V2TIMMessage > *	callback
	)

pure virtual

5.7 Add a message to the group message list

This API is mainly used to meet the requirement of inserting informative messages, such as "you have exited the group", into a group chat conversation. Such messages need to be displayed in the chat interface but do not need to be sent to others. Messages that need to be displayed in the chat interface but do not need to be sent to others. Therefore, insertGroupMessageToLocalStorage() is equivalent to a sendMessage() API whose network sending capability is 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()

virtual V2TIMString InsertC2CMessageToLocalStorage	(	V2TIMMessage &	message,
		const V2TIMString &	userID,
		const V2TIMString &	sender,
		V2TIMValueCallback< V2TIMMessage > *	callback
	)

pure virtual

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

This API is mainly used to meet the requirement of inserting informative messages, such as "you have exited the group", into a one-to-one chat conversation. Such messages need to be displayed in the chat interface but do not need to be sent to the peer party. Messages that need to be displayed in the chat interface but do not need to be sent to others. Therefore, insertC2CMessageToLocalStorage() is equivalent to a sendMessage() API whose network sending capability is 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()

virtual void FindMessages	(	const V2TIMStringVector &	messageIDList,
		V2TIMValueCallback< V2TIMMessageVector > *	callback
	)

pure virtual

5.9 Query local messages in a specified conversation by messageID

Parameters

messageIDList Message ID list

◆ SearchLocalMessages()

virtual void SearchLocalMessages	(	const V2TIMMessageSearchParam &	searchParam,
		V2TIMValueCallback< V2TIMMessageSearchResult > *	callback
	)

pure virtual

5.10 Search for local messages (supported only in 5.4.666 and later versions and need to buy Flagship Edition)

Parameters

searchParam Message search parameter. For details, see the definition of V2TIMMessageSearchParam.

◆ SearchCloudMessages()

virtual void SearchCloudMessages	(	const V2TIMMessageSearchParam &	searchParam,
		V2TIMValueCallback< V2TIMMessageSearchResult > *	callback
	)

pure virtual

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

Parameters

searchParam Message search parameter. For details, see the definition of V2TIMMessageSearchParam.

Attention

This feature is an enhanced service for IM. 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()

virtual void SendMessageReadReceipts	(	const V2TIMMessageVector &	messageList,
		V2TIMCallback *	callback
	)

pure virtual

5.12 Send read receipts to the message sender for message which have been received（Supported only in 6.1 and later versions and need to buy Flagship Edition）

Parameters

messageList Message list

Attention

Notes:

To send a read receipt to a group message, you need to go to the console and turn on the corresponding switch.
After the API is called successfully, the conversation unread count will not change, and the message sender will receive the OnRecvMessageReadReceipts callback, which will carry the latest read information of the message.

◆ GetMessageReadReceipts()

virtual void GetMessageReadReceipts	(	const V2TIMMessageVector &	messageList,
		V2TIMValueCallback< V2TIMMessageReceiptVector > *	callback
	)

pure virtual

5.13 Get read receipts for messages which have been sent by myself（Supported only in 6.1 and later versions and need to buy Flagship Edition）

Parameters

messageList Message list

Attention

Notes:

To obtain the read receipt of group message, you need to go to the console and turn on the corresponding switch.
The messages in messageList must be in the same conversation.

◆ GetGroupMessageReadMemberList()

virtual void GetGroupMessageReadMemberList	(	const V2TIMMessage &	message,
		V2TIMGroupMessageReadMembersFilter	filter,
		uint64_t	nextSeq,
		uint32_t	count,
		V2TIMValueCallback< V2TIMGroupMessageReadMemberList > *	callback
	)

pure virtual

5.14 Get group members profile who have read ths message（Supported only in 6.1 and later versions and need to buy Flagship Edition）

Parameters

message	group message
filter	Specify the group message read members type.
nextSeq	Pulling-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.
count	Number of read members pulled per page. Supports up to 100.

Attention

Notes:

Please go to the console and turn on the corresponding switch before using this feature.

◆ SetMessageExtensions()

virtual void SetMessageExtensions	(	const V2TIMMessage &	message,
		const V2TIMMessageExtensionVector &	extensions,
		V2TIMValueCallback< V2TIMMessageExtensionResultVector > *	callback
	)

pure virtual

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

Parameters

message	The target message must be sent successfully and its supportMessageExtension field must be set to YES before sending. In addition, AVChatRoom message do not support this feature.
extensions	The existing message extensions will be updated, and non-existing message extensions will be added directly.

Attention

You need to buy Flagship 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.
When multiple users set or delete the same extension key at the same time, only the first user can execute it successfully, and other users will receive the 23001 error code and the newest extension information. A retry operation can be invoked after receiveing the newest information.
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()

virtual void GetMessageExtensions	(	const V2TIMMessage &	message,
		V2TIMValueCallback< V2TIMMessageExtensionVector > *	callback
	)

pure virtual

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

◆ DeleteMessageExtensions()

virtual void DeleteMessageExtensions	(	const V2TIMMessage &	message,
		const V2TIMStringVector &	keys,
		V2TIMValueCallback< V2TIMMessageExtensionResultVector > *	callback
	)

pure virtual

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

Parameters

keys	Message extension key list, A maximum of 20 message extensions can be deleted at a time , if set to nil , it means to delete all extensions of the message.

Attention

When multiple users set or delete the same extension key at the same time, only the first user can execute it successfully, and other users will receive the 23001 error code and the newest extension information. A retry operation can be invoked after receiveing the newest information.

◆ AddMessageReaction()

virtual void AddMessageReaction	(	const V2TIMMessage &	message,
		const V2TIMString &	reactionID,
		V2TIMCallback *	callback
	)

pure virtual

5.18 Add 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 |

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

Users can paginate fetching user profile based on a specific emoji.

You can implement emoji response capabilities based on SDK API:

1、Call AddMessageReaction interface to add an emoji to a message. After adding successfully, the current operating user will be stored under the emoji.

2、Call RemoveMessageReaction interface to delete the added emoji. After deleting successfully, the current operating user will no longer be stored under the emoji.

3、Call GetMessageReactions interface to batch fetch the emoji list of multiple messages. Each emoji contains the total number of current users and the first N (default 10) user profiles.

4、Call GetAllUserListOfMessageReaction interface to paginate fetching the full list of user profiles using the message emoji.

5、Listen to the onRecvMessageReactionsChanged callback to perceive the change of user profile of the emoji. The callback will carry the latest user profile of the emoji (including the total number of users and the first N user profiles).

Parameters

reactionID Message reaction ID, in the emoji reply 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 Flagship 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 reaction already contains the current operating user, the interface will report ERR_SVR_MSG_REACTION_ALREADY_CONTAIN_USER error.

◆ RemoveMessageReaction()

virtual void RemoveMessageReaction	(	const V2TIMMessage &	message,
		const V2TIMString &	reactionID,
		V2TIMCallback *	callback
	)

pure virtual

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

Attention

You need to buy Flagship Edition to use this feature.
If the reaction does not exist, the interface will report ERR_SVR_MSG_REACTION_NOT_EXISTS error.
If the reaction does not contain the current user, the interface will report ERR_SVR_MSG_REACTION_NOT_CONTAIN_USER error.

◆ GetMessageReactions()

virtual void GetMessageReactions	(	const V2TIMMessageVector &	messageList,
		uint32_t	maxUserCountPerReaction,
		V2TIMValueCallback< V2TIMMessageReactionResultVector > *	callback
	)

pure virtual

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

Parameters

messageList	Message list, supports up to 20 messages at a time, messages must belong to the same conversation.
maxUserCountPerReaction	The 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 Flagship Edition to use this feature.

◆ GetAllUserListOfMessageReaction()

virtual void GetAllUserListOfMessageReaction	(	const V2TIMMessage &	message,
		const V2TIMString &	reactionID,
		uint32_t	nextSeq,
		uint32_t	count,
		V2TIMValueCallback< V2TIMMessageReactionUserResult > *	callback
	)

pure virtual

5.21 Get all user list of message reaction (supported only in 7.4 and later versions)

Parameters

message	Message object
reactionID	Message reaction ID
nextSeq	The next pulling-by-page cursor, pass 0 for the first time, and pass the nextSeq returned by succ for subsequent pagination.
count	The maximum count of users fetched per page, up to 100.

Attention

You need to buy Flagship Edition to use this feature.

◆ TranslateText()

virtual void TranslateText	(	const V2TIMStringVector &	sourceTextList,
		const V2TIMString &	sourceLanguage,
		const V2TIMString &	targetLanguage,
		V2TIMValueCallback< V2TIMStringToV2TIMStringMap > *	callback
	)

pure virtual

5.22 Translate text message.

Parameters

sourceTextList	Texts to be translated.
sourceLanguage	Source 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.
targetLanguage	Target 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.
callback	Translated result callback. The key represents the source text and value represents target text.

◆ MarkC2CMessageAsRead()

virtual void MarkC2CMessageAsRead	(	const V2TIMString &	userID,
		V2TIMCallback *	callback
	)

pure virtual

5.23 Mark one-to-one messages as read (It is deprecated and discouraged to call this function. Please call API cleanConversationUnreadMessageCount instead)

Attention

Notes:

After the API is successfully called, your unread count will be cleared to 0, and the peer user will receive the OnRecvC2CReadReceipt callback, which will carry the time marked conversation read.
If the userID is nil, all one-to-one messages wil be marked as read. More importantly, it only supported in 5.8 and later versions.

◆ MarkGroupMessageAsRead()

virtual void MarkGroupMessageAsRead	(	const V2TIMString &	groupID,
		V2TIMCallback *	callback
	)

pure virtual

5.24 Mark group messages as read (It is deprecated and discouraged to call this function. Please call API cleanConversationUnreadMessageCount instead)

Attention

Notes:

After the API is successfully called, your unread count will be cleared to 0.
If the groupID is nil, all group messages wil be marked as read. More importantly, it only supported in 5.8 and later versions.

◆ MarkAllMessageAsRead()

virtual void MarkAllMessageAsRead ( V2TIMCallback * callback )

pure virtual

5.25 Mark all messages as read (It is deprecated and discouraged to call this function. Please call API cleanConversationUnreadMessageCount instead)

Public Member Functions

Constructor & Destructor Documentation

◆ ~V2TIMMessageManager()

Member Function Documentation

◆ AddAdvancedMsgListener()

◆ RemoveAdvancedMsgListener()

◆ CreateTextMessage()

◆ CreateTextAtMessage()

◆ CreateCustomMessage() [1/2]

◆ CreateCustomMessage() [2/2]

◆ CreateImageMessage()

◆ CreateSoundMessage()

◆ CreateVideoMessage()

◆ CreateFileMessage()

◆ CreateLocationMessage()

◆ CreateFaceMessage()

◆ CreateMergerMessage()

◆ CreateForwardMessage()

◆ CreateTargetedGroupMessage()

◆ CreateAtSignedGroupMessage()

◆ SendMessage()

◆ SetC2CReceiveMessageOpt()

◆ GetC2CReceiveMessageOpt()

◆ SetGroupReceiveMessageOpt()

◆ SetAllReceiveMessageOpt() [1/2]

◆ SetAllReceiveMessageOpt() [2/2]

◆ GetAllReceiveMessageOpt()

◆ GetHistoryMessageList()

◆ RevokeMessage()

◆ ModifyMessage()

◆ DeleteMessages()

◆ ClearC2CHistoryMessage()

◆ ClearGroupHistoryMessage()

◆ InsertGroupMessageToLocalStorage()

◆ InsertC2CMessageToLocalStorage()

◆ FindMessages()

◆ SearchLocalMessages()

◆ SearchCloudMessages()

◆ SendMessageReadReceipts()

◆ GetMessageReadReceipts()

◆ GetGroupMessageReadMemberList()

◆ SetMessageExtensions()

◆ GetMessageExtensions()

◆ DeleteMessageExtensions()

◆ AddMessageReaction()

◆ RemoveMessageReaction()

◆ GetMessageReactions()

◆ GetAllUserListOfMessageReaction()

◆ TranslateText()

◆ MarkC2CMessageAsRead()

◆ MarkGroupMessageAsRead()

◆ MarkAllMessageAsRead()