V2TIMMessageManager class

Constructors

V2TIMMessageManager.new()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addAdvancedMsgListener({required V2TimAdvancedMsgListener listener}) → Future<void>

添加高级消息的事件监听器

addMessageReaction({V2TimMessage? message, String? msgID, required String reactionID}) → Future<V2TimCallback>

添加消息回应（可以用于实现表情回应）

appendMessage({required String createMessageBaseId, required String createMessageAppendId}) → Future<V2TimValueCallback<V2TimMessage>>

添加多Element消息。待废弃

clearC2CHistoryMessage({required String userID}) → Future<V2TimCallback>

清空单聊本地及云端的消息（不删除会话）

clearGroupHistoryMessage({required String groupID}) → Future<V2TimCallback>

清空群聊本地及云端的消息（不删除会话）

convertVoiceToText({V2TimMessage? message, String? msgID, required String language, String? webMessageInstance}) → Future<V2TimValueCallback<String>>

将语音转成文字

createAtSignedGroupMessage({V2TimMessage? message, String? createdMsgID, required List<String> atUserList}) → Future<V2TimValueCallback<V2TimMessage>>

创建带 @ 标记的群消息

createCustomMessage({required String data, String desc = "", String extension = ""}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建定制化消息

createFaceMessage({required int index, required String data}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建表情消息

createFileMessage({required String filePath, required String fileName, dynamic inputElement}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建文件消息

createForwardMessage({V2TimMessage? message, String? msgID, String? webMessageInstance}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建转发消息

createImageMessage({required String imagePath, dynamic inputElement, String? imageName}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建图片消息（图片文件最大支持 28 MB）

createLocationMessage({required String desc, required double longitude, required double latitude}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建位置信息

createMergerMessage({List<V2TimMessage>? messageList, List<String>? msgIDList, required String title, required List<String> abstractList, required String compatibleText}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建合并消息

createSoundMessage({required String soundPath, required int duration}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建音频文件

createTargetedGroupMessage({V2TimMessage? message, String? id, required List<String> receiverList}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

如果您需要在群内给指定群成员列表发消息，可以创建一条定向群消息，定向群消息只有指定群成员才能收到。

createTextAtMessage({required String text, required List<String> atUserList}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建文本消息，并且可以附带 @ 提醒功能。提醒消息仅适用于在群组中发送的消息

createTextMessage({required String text}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建文本消息

createVideoMessage({required String videoFilePath, required String type, required int duration, required String snapshotPath, dynamic inputElement}) → Future<V2TimValueCallback<V2TimMsgCreateInfoResult>>

创建视频文件

deleteMessageExtensions({V2TimMessage? message, String? msgID, required List<String> keys}) → Future<V2TimValueCallback<List<V2TimMessageExtensionResult>>>

deleteMessageFromLocalStorage({V2TimMessage? message, String? msgID}) → Future<V2TimCallback>

删除本地消息

deleteMessages({List<V2TimMessage>? messageList, List<String>? msgIDs, List? webMessageInstanceList}) → Future<V2TimCallback>

删除本地及漫游消息

downloadMergerMessage({V2TimMessage? message, String? msgID, String? webMessageInstance}) → Future<V2TimValueCallback<List<V2TimMessage>>>

获取合并消息的子消息列表（下载被合并的消息列表） 参数： message 合并消息 msgID 合并消息的 msgID，待废弃，请使用 message 参数

downloadMessage({V2TimMessage? message, String? msgID, required int messageType, required int imageType, required bool isSnapshot, String? downloadPath}) → Future<V2TimCallback>

下载多媒体消息

findMessages({required List<String> messageIDList}) → Future<V2TimValueCallback<List<V2TimMessage>>>

根据 messageID 查询指定会话中的本地消息 参数：messageIDList 消息ID列表

getAllReceiveMessageOpt() → Future<V2TimValueCallback<V2TimReceiveMessageOptInfo>>

获取全局消息接收选项

getAllUserListOfMessageReaction({V2TimMessage? message, String? msgID, required String reactionID, required int nextSeq, required int count, String? webMessageInstance}) → Future<V2TimValueCallback<V2TimMessageReactionUserResult>>

分页拉取使用指定消息回应用户信息

getC2CHistoryMessageList({required String userID, required int count, V2TimMessage? lastMsg, String? lastMsgID}) → Future<V2TimValueCallback<List<V2TimMessage>>>

获取单聊历史消息

getC2CReceiveMessageOpt({required List<String> userIDList}) → Future<V2TimValueCallback<List<V2TimReceiveMessageOptInfo>>>

查询针对某个用户的 C2C 消息接收选项

getGroupHistoryMessageList({required String groupID, required int count, V2TimMessage? lastMsg, String? lastMsgID}) → Future<V2TimValueCallback<List<V2TimMessage>>>

获取群组历史消息

getGroupMessageReadMemberList({V2TimMessage? message, String? messageID, required GetGroupMessageReadMemberListFilter filter, int nextSeq = 0, int count = 100}) → Future<V2TimValueCallback<V2TimGroupMessageReadMemberList>>

获取群消息已读群成员列表

getHistoryMessageList({HistoryMsgGetTypeEnum? getType = HistoryMsgGetTypeEnum.V2TIM_GET_LOCAL_OLDER_MSG, String? userID, String? groupID, int lastMsgSeq = -1, required int count, V2TimMessage? lastMsg, String? lastMsgID, List<int>? messageTypeList, List<int>? messageSeqList, int? timeBegin, int? timePeriod}) → Future<V2TimValueCallback<List<V2TimMessage>>>

获取历史消息高级接口

getHistoryMessageListV2({HistoryMsgGetTypeEnum? getType = HistoryMsgGetTypeEnum.V2TIM_GET_LOCAL_OLDER_MSG, String? userID, String? groupID, int lastMsgSeq = -1, required int count, V2TimMessage? lastMsg, String? lastMsgID, List<int>? messageTypeList, List<int>? messageSeqList, int? timeBegin, int? timePeriod}) → Future<V2TimValueCallback<V2TimMessageListResult>>

获取历史消息高级接口

getHistoryMessageListWithoutFormat({HistoryMsgGetTypeEnum? getType = HistoryMsgGetTypeEnum.V2TIM_GET_LOCAL_OLDER_MSG, String? userID, String? groupID, int lastMsgSeq = -1, required int count, String? lastMsgID, List<int>? messageSeqList, int? timeBegin, int? timePeriod}) → Future<LinkedHashMap>

已废弃 获取历史消息高级接口(没有处理Native返回数据)

getMessageExtensions({V2TimMessage? message, String? msgID}) → Future<V2TimValueCallback<List<V2TimMessageExtension>>>

获取消息扩展（Flutter SDK 4.2.0及以上版本支持，需要您购买旗舰版套餐）

getMessageOnlineUrl({V2TimMessage? message, String? msgID}) → Future<V2TimValueCallback<V2TimMessageOnlineUrl>>

获取多媒体消息URL

getMessageReactions({List<V2TimMessage>? messageList, List<String>? msgIDList, required int maxUserCountPerReaction, List<String>? webMessageInstanceList}) → Future<V2TimValueCallback<List<V2TimMessageReactionResult>>>

批量拉取多条消息回应信息

getMessageReadReceipts({List<V2TimMessage>? messageList, List<String>? messageIDList}) → Future<V2TimValueCallback<List<V2TimMessageReceipt>>>

获取消息已读回执

getPinnedGroupMessageList({required String groupID}) → Future<V2TimValueCallback<List<V2TimMessage>>>

获取已置顶的群消息列表

insertC2CMessageToLocalStorage({required String data, required String userID, required String sender}) → Future<V2TimValueCallback<V2TimMessage>>

向C2C消息列表中添加一条消息。该接口已废弃，请使用 insertC2CMessageToLocalStorageV2

insertC2CMessageToLocalStorageV2({required String userID, required String senderID, V2TimMessage? message, String? createdMsgID}) → Future<V2TimValueCallback<V2TimMessage>>

向C2C消息列表中添加一条消息。

insertGroupMessageToLocalStorage({required String data, required String groupID, required String sender}) → Future<V2TimValueCallback<V2TimMessage>>

向群组消息列表中添加一条消息。该接口已废弃，请使用 insertGroupMessageToLocalStorageV2

insertGroupMessageToLocalStorageV2({required String groupID, required String senderID, V2TimMessage? message, String? createdMsgID}) → Future<V2TimValueCallback<V2TimMessage>>

向群组消息列表中添加一条消息。

markAllMessageAsRead() → Future<V2TimCallback>

标记所有消息为已读。待废弃 请使用 V2TIMConversationManager.cleanConversationUnreadMessageCount 接口

markC2CMessageAsRead({required String userID}) → Future<V2TimCallback>

设置单聊消息已读。待废弃 请使用 V2TIMConversationManager.cleanConversationUnreadMessageCount 接口

markGroupMessageAsRead({required String groupID}) → Future<V2TimCallback>

设置群组消息已读。待废弃 请使用 V2TIMConversationManager.cleanConversationUnreadMessageCount 接口

modifyMessage({required V2TimMessage message}) → Future<V2TimValueCallback<V2TimMessageChangeInfo>>

消息变更

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pathExits(String fpath) → Future<bool>

pinGroupMessage({V2TimMessage? message, String? msgID, required String groupID, required bool isPinned}) → Future<V2TimCallback>

设置群消息置顶

removeAdvancedMsgListener({V2TimAdvancedMsgListener? listener}) → Future<void>

移除高级消息监听器

removeMessageReaction({V2TimMessage? message, String? msgID, required String reactionID}) → Future<V2TimCallback>

reSendMessage({required String msgID, bool onlineUserOnly = false, Object? webMessageInstatnce}) → Future<V2TimValueCallback<V2TimMessage>>

消息重发

revokeMessage({V2TimMessage? message, String? msgID, Object? webMessageInstatnce}) → Future<V2TimCallback>

撤回消息

searchCloudMessages({required V2TimMessageSearchParam searchParam}) → Future<V2TimValueCallback<V2TimMessageSearchResult>>

搜索云端消息

searchLocalMessages({required V2TimMessageSearchParam searchParam}) → Future<V2TimValueCallback<V2TimMessageSearchResult>>

搜索本地消息

sendCustomMessage({required String data, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, String desc = "", String extension = "", bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo}) → Future<V2TimValueCallback<V2TimMessage>>

发送自定义消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createCustomMessage创建消息,再调用sendMessage发送消息

sendFaceMessage({required int index, required String data, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo}) → Future<V2TimValueCallback<V2TimMessage>>

发送表情消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createFaceMessage创建消息,再调用sendMessage发送消息

sendFileMessage({required String filePath, required String fileName, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo, Uint8List? fileContent}) → Future<V2TimValueCallback<V2TimMessage>>

发送文件。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createFileMessage创建消息,再调用sendMessage发送消息 web 端 fileName、fileContent 为必传字段

sendForwardMessage({required String msgID, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo, String? webMessageInstance}) → Future<V2TimValueCallback<V2TimMessage>>

转发消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createForwardMessage创建消息,再调用sendMessage发送消息

sendImageMessage({required String imagePath, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo, String? fileName, Uint8List? fileContent}) → Future<V2TimValueCallback<V2TimMessage>>

*****************************************************************************************/ *****************************************************************************************/ *********************************************************************************/ 以下接口为废弃接口，不再提供支持/ *****************************************************************************************/ *****************************************************************************************/ *****************************************************************************************/ 发送图片消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createVideoMessage创建消息,再调用sendMessage发送消息'

sendLocationMessage({required String desc, required double longitude, required double latitude, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo}) → Future<V2TimValueCallback<V2TimMessage>>

发送地理位置消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createLocationMessage创建消息,再调用sendMessage发送消息

sendMergerMessage({required List<String> msgIDList, required String title, required List<String> abstractList, required String compatibleText, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo, List<String>? webMessageInstanceList}) → Future<V2TimValueCallback<V2TimMessage>>

合并消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createMergerMessage创建消息,再调用sendMessage发送消息

sendMessage({String? id, V2TimMessage? message, void onSyncMsgID(String msgID)?, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, OfflinePushInfo? offlinePushInfo, bool isExcludedFromUnreadCount = false, bool isExcludedFromLastMessage = false, bool? isSupportMessageExtension = false, bool? isExcludedFromContentModeration = false, bool needReadReceipt = false, String? cloudCustomData, String? localCustomData, bool? isDisableCloudMessagePreHook = false, bool? isDisableCloudMessagePostHook = false}) → Future<V2TimValueCallback<V2TimMessage>>

发送消息

sendMessageReadReceipts({List<V2TimMessage>? messageList, List<String>? messageIDList}) → Future<V2TimCallback>

发送消息已读回执

sendReplyMessage({required String id, required String receiver, required String groupID, required V2TimMessage replyMessage, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, bool needReadReceipt = false, OfflinePushInfo? offlinePushInfo, String? localCustomData}) → Future<V2TimValueCallback<V2TimMessage>>

发送回复消息。从 8.3 版本开始弃用

sendSoundMessage({required String soundPath, required String receiver, required String groupID, required int duration, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo}) → Future<V2TimValueCallback<V2TimMessage>>

发送语音消息。该接口已废弃

sendTextAtMessage({required String text, required List<String> atUserList, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo}) → Future<V2TimValueCallback<V2TimMessage>>

创建文本消息，并且可以附带 @ 提醒功能。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createTextAtMessage创建消息,再调用sendMessage发送消息

sendTextMessage({required String text, required String receiver, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo}) → Future<V2TimValueCallback<V2TimMessage>>

发送高级文本消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createTextMessage创建消息,再调用sendMessage发送消息

sendVideoMessage({required String videoFilePath, required String receiver, required String type, required String snapshotPath, required int duration, required String groupID, MessagePriorityEnum? priority = MessagePriorityEnum.V2TIM_PRIORITY_NORMAL, bool onlineUserOnly = false, bool isExcludedFromUnreadCount = false, OfflinePushInfo? offlinePushInfo, String? fileName, Uint8List? fileContent}) → Future<V2TimValueCallback<V2TimMessage>>

发送视频消息。该接口已废弃 自3.6.0开始弃用，我们将创建消息与发送消息分离，请先使用createVideoMessage创建消息,再调用sendMessage发送消息'

setAllReceiveMessageOpt({required int opt, required int startHour, required int startMinute, required int startSecond, required int duration}) → Future<V2TimCallback>

设置全局消息接收选项 opt 全局消息接收选项，支持两种取值：

setAllReceiveMessageOptWithTimestamp({required int opt, required int startTimeStamp, required int duration}) → Future<V2TimCallback>

设置全局消息接收选项 opt 全局消息接收选项，支持两种取值：

setC2CReceiveMessageOpt({required List<String> userIDList, required ReceiveMsgOptEnum opt}) → Future<V2TimCallback>

设置用户消息接收选项

setCloudCustomData({V2TimMessage? message, String? msgID, required String data}) → Future<V2TimCallback>

设置云端自定义数据（云端保存，会发送到对端，程序卸载重装后还能拉取到）

setGroupReceiveMessageOpt({required String groupID, required ReceiveMsgOptEnum opt}) → Future<V2TimCallback>

修改群消息接收选项

setLocalCustomData({V2TimMessage? message, String? msgID, required String localCustomData}) → Future<V2TimCallback>

设置消息自定义数据（本地保存，不会发送到对端，程序卸载重装后失效）

setLocalCustomInt({V2TimMessage? message, String? msgID, required int localCustomInt}) → Future<V2TimCallback>

设置消息自定义数据，可以用来标记语音、视频消息是否已经播放（本地保存，不会发送到对端，程序卸载重装后失效）

setMessageExtensions({V2TimMessage? message, String? msgID, required List<V2TimMessageExtension> extensions}) → Future<V2TimValueCallback<List<V2TimMessageExtensionResult>>>

设置消息扩展（Flutter SDK 4.2.0及以上版本支持，需要您购买旗舰版套餐）

toString() → String

A string representation of this object.

inherited

translateText({required List<String> texts, String? sourceLanguage, required String targetLanguage}) → Future<V2TimValueCallback<Map<String, String>>>

翻译文本消息

Operators

operator ==(Object other) → bool

The equality operator.

inherited