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	PinGroupMessage (const V2TIMString &groupID, const V2TIMMessage &message, bool isPinned, V2TIMCallback *callback)=0

virtual void	GetPinnedGroupMessageList (const V2TIMString &groupID, V2TIMValueCallback< V2TIMMessageVector > *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 mentioning(@) feature

You can mention someone only in group chats.

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 groups do not support @ 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 to be displayed for offline push
extension	Extension field for 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 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

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)

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

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 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]".
compatibleText	Text to be displayed if the SDK version does not support combined messages. This parameter cannot be null.

◆ 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.
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()

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

pure virtual

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

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 groups do not support @ 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 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).
offlinePushInfo	Title and voice carried when the message pushing offline.

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

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

Parameters

opt There are five 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. V2TIMMessage.V2TIM_NOT_RECEIVE_MESSAGE_EXCEPT_AT: only receive @ messages.

◆ 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.（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 - 246060) 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]

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.（you can use this to mute group chat notifications）
startTimeStamp	The start time of muting, UTC timestamp, unit: second
duration	The muting duration in seconds

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

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

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

pure virtual

5.3 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.

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

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

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

pure virtual

5.9 Query local messages in a specified conversation by messageID, including messages with the status V2TIM_MSG_STATUS_LOCAL_REVOKED (recalled) and V2TIM_MSG_STATUS_HAS_DELETED (deleted).

Parameters

messageIDList Message ID list

Attention: Distinguish the status of a message by its status in V2TIMMessage

◆ SearchLocalMessages()

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

pure virtual

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

Parameters

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

Attention: The returned list does not include messages with the status V2TIM_MSG_STATUS_LOCAL_REVOKED (recalled) and V2TIM_MSG_STATUS_HAS_DELETED (deleted).

◆ 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 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.
The returned list does not include messages with the status V2TIM_MSG_STATUS_LOCAL_REVOKED (recalled) and V2TIM_MSG_STATUS_HAS_DELETED (deleted).

◆ SendMessageReadReceipts()

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

pure virtual

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

Parameters

messageList Message list

Attention

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

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

pure virtual

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

Parameters

messageList Message list

Attention

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 who have read a group message (Supported only in Chat Premium 6.1 and later)

Parameters

message	group message
filter	Whether to get members who have or who have not read the message.
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

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

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

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

pure virtual

5.18 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

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

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

pure virtual

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

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, which 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 Premium 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 a list of users who responded with an emoji (supported only in 7.4 and later versions)

Parameters

message	Message object
reactionID	Message reaction ID
nextSeq	The 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 Premium 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.

◆ PinGroupMessage()

virtual void PinGroupMessage	(	const V2TIMString &	groupID,
		const V2TIMMessage &	message,
		bool	isPinned,
		V2TIMCallback *	callback
	)

pure virtual

5.23 Set the group message to the top（supported only in Chat Premium 7.9 and later versions）

Parameters

groupID	Group ID
isPinned	Whether 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()

virtual void GetPinnedGroupMessageList	(	const V2TIMString &	groupID,
		V2TIMValueCallback< V2TIMMessageVector > *	callback
	)

pure virtual

5.24 Get the list of pinned group messages（supported only in Chat Premium 7.9 and later versions）

Parameters

groupID Group ID

Attention

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

◆ MarkC2CMessageAsRead()

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

pure virtual

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

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

pure virtual

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

virtual void MarkAllMessageAsRead ( V2TIMCallback * callback )

pure virtual

5.27 Mark all messages as read (This is to be deprecated. Please call 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()

◆ PinGroupMessage()

◆ GetPinnedGroupMessageList()

◆ MarkC2CMessageAsRead()

◆ MarkGroupMessageAsRead()

◆ MarkAllMessageAsRead()