消息服务更多...

#include <v2_nim_message_service.hpp>

Public 成员函数
virtual void	sendMessage (V2NIMMessage message, nstd::string conversationId, V2NIMSendMessageParams params, V2NIMSuccessCallback< V2NIMSendMessageResult > success, V2NIMFailureCallback failure, V2NIMProgressCallback progress)=0
	发送消息

virtual void	replyMessage (V2NIMMessage message, V2NIMMessage replyMessage, V2NIMSendMessageParams params, V2NIMSuccessCallback< V2NIMSendMessageResult > success, V2NIMFailureCallback failure, V2NIMProgressCallback progress)=0
	回复消息

virtual void	modifyMessage (const V2NIMMessage &message, const V2NIMModifyMessageParams &params, const V2NIMSuccessCallback< const V2NIMModifyMessageResult & > &success, const V2NIMFailureCallback &failure)=0
	更新消息

virtual void	revokeMessage (V2NIMMessage message, V2NIMMessageRevokeParams params, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	撤回消息

virtual void	getMessageList (V2NIMMessageListOption option, V2NIMSuccessCallback< nstd::vector< V2NIMMessage > > success, V2NIMFailureCallback failure)=0
	查询消息

virtual void	getMessageListByIds (nstd::vector< nstd::string > messageClientIds, V2NIMSuccessCallback< nstd::vector< V2NIMMessage > > success, V2NIMFailureCallback failure)=0
	根据 ID 列表查询消息

virtual void	getMessageListByRefers (nstd::vector< V2NIMMessageRefer > messageRefers, V2NIMSuccessCallback< nstd::vector< V2NIMMessage > > success, V2NIMFailureCallback failure)=0
	根据消息引用列表查询消息

virtual void	getThreadMessageList (V2NIMThreadMessageListOption threadMessageListOption, V2NIMSuccessCallback< V2NIMThreadMessageListResult > success, V2NIMFailureCallback failure)=0
	查询 thread 聊天云端消息列表

virtual void	getLocalThreadMessageList (V2NIMMessageRefer messageRefer, V2NIMSuccessCallback< V2NIMThreadMessageListResult > success, V2NIMFailureCallback failure)=0
	查询 thread 聊天本地消息列表

virtual void	deleteMessage (V2NIMMessage message, nstd::optional< nstd::string > serverExtension, bool onlyDeleteLocal, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	删除消息

virtual void	deleteMessages (nstd::vector< V2NIMMessage > messages, nstd::optional< nstd::string > serverExtension, bool onlyDeleteLocal, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	批量删除消息

virtual void	clearHistoryMessage (V2NIMClearHistoryMessageOption option, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	清空历史消息

virtual void	updateMessageLocalExtension (V2NIMMessage message, nstd::string localExtension, V2NIMSuccessCallback< V2NIMMessage > success, V2NIMFailureCallback failure)=0
	更新消息本地扩展

virtual void	insertMessageToLocal (V2NIMMessage message, nstd::string conversationId, nstd::string senderId, uint64_t createTime, V2NIMSuccessCallback< V2NIMMessage > success, V2NIMFailureCallback failure)=0
	插入本地消息

virtual void	pinMessage (V2NIMMessage message, nstd::optional< nstd::string > serverExtension, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	pin 消息

virtual void	unpinMessage (V2NIMMessageRefer messageRefer, nstd::optional< nstd::string > serverExtension, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	取消 pin 消息

virtual void	updatePinMessage (V2NIMMessage message, nstd::optional< nstd::string > serverExtension, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	更新 pin 消息

virtual void	getPinnedMessageList (nstd::string conversationId, V2NIMSuccessCallback< nstd::vector< V2NIMMessagePin > > success, V2NIMFailureCallback failure)=0
	获取 pin 消息列表

virtual void	addQuickComment (V2NIMMessage message, uint64_t index, nstd::optional< nstd::string > serverExtension, V2NIMMessageQuickCommentPushConfig pushConfig, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	添加快捷评论

virtual void	removeQuickComment (V2NIMMessageRefer messageRefer, uint32_t index, nstd::optional< nstd::string > serverExtension, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	移除快捷评论

virtual void	getQuickCommentList (nstd::vector< V2NIMMessage > messages, V2NIMSuccessCallback< nstd::map< nstd::string, nstd::vector< V2NIMMessageQuickComment > > > success, V2NIMFailureCallback failure)=0
	获取快捷评论列表

virtual void	addCollection (V2NIMAddCollectionParams params, V2NIMSuccessCallback< V2NIMCollection > success, V2NIMFailureCallback failure)=0
	添加收藏

virtual void	removeCollections (nstd::vector< V2NIMCollection > collections, V2NIMSuccessCallback< uint32_t > success, V2NIMFailureCallback failure)=0
	移除收藏

virtual void	updateCollectionExtension (V2NIMCollection collection, nstd::optional< nstd::string > serverExtension, V2NIMSuccessCallback< V2NIMCollection > success, V2NIMFailureCallback failure)=0
	更新收藏扩展字段

virtual void	getCollectionListByOption (V2NIMCollectionOption option, V2NIMSuccessCallback< nstd::vector< V2NIMCollection > > success, V2NIMFailureCallback failure)=0
	分页获取收藏列表

virtual void	sendP2PMessageReceipt (V2NIMMessage message, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	发送 P2P 消息已读回执

virtual void	getP2PMessageReceipt (nstd::string conversationId, V2NIMSuccessCallback< V2NIMP2PMessageReadReceipt > success, V2NIMFailureCallback failure)=0
	查询 P2P 消息已读回执状态

virtual bool	isPeerRead (V2NIMMessage message)=0
	查询 P2P 消息对方是否已读

virtual void	sendTeamMessageReceipts (nstd::vector< V2NIMMessage > messages, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	发送群消息已读回执

virtual void	getTeamMessageReceipts (nstd::vector< V2NIMMessage > messages, V2NIMSuccessCallback< nstd::vector< V2NIMTeamMessageReadReceipt > > success, V2NIMFailureCallback failure)=0
	获取群消息已读回执状态

virtual void	getTeamMessageReceiptDetail (V2NIMMessage message, nstd::set< nstd::string > memberAccountIds, V2NIMSuccessCallback< V2NIMTeamMessageReadReceiptDetail > success, V2NIMFailureCallback failure)=0
	获取群消息已读回执详情

virtual void	voiceToText (V2NIMVoiceToTextParams params, V2NIMSuccessCallback< nstd::string > success, V2NIMFailureCallback failure)=0
	语音转文字

virtual void	cancelMessageAttachmentUpload (V2NIMMessage message, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	取消文件消息附件上传

virtual void	searchCloudMessages (V2NIMMessageSearchParams params, V2NIMSuccessCallback< nstd::vector< V2NIMMessage > > success, V2NIMFailureCallback failure)=0
	搜索云端消息

virtual void	addMessageListener (V2NIMMessageListener listener)=0
	添加消息监听器

virtual void	removeMessageListener (V2NIMMessageListener listener)=0
	移除消息监听器

详细描述

消息服务

前置条件: 调用 V2NIMClient::get() 拿到 client 实例调用 client.getMessageService() 拿到 messageService 实例

示例代码: auto& client = V2NIMClient::get();

auto& messageService = client.getMessageService();

v2::V2NIMClient::get
static V2NIMClient & get()
获取 IM 客户端实例
Definition: v2_nim_api.hpp:428

成员函数说明

◆ addCollection()

virtual void v2::V2NIMMessageService::addCollection	(	V2NIMAddCollectionParams	params,
		V2NIMSuccessCallback< V2NIMCollection >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

添加收藏

参数

params	添加收藏相关参数
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMAddCollectionParams params;

params.collectionClientId = "id1";

params.collectionType = 1;

params.collectionData = "data";

params.serverExtension = "serverExtension";

messageService.addCollection(

params,

[](V2NIMCollection collection) {

// add collection succeeded

},

[](V2NIMError error) {

// add collection failed, handle error

});

v2::V2NIMError
Definition: v2_nim_def_struct.hpp:7

v2::V2NIMCollection
Definition: v2_nim_def_struct.hpp:1047

v2::V2NIMAddCollectionParams
Definition: v2_nim_def_struct.hpp:1062

v2::V2NIMAddCollectionParams::serverExtension
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:1068

v2::V2NIMAddCollectionParams::collectionType
uint32_t collectionType
收藏类型
Definition: v2_nim_def_struct.hpp:1064

v2::V2NIMAddCollectionParams::collectionData
nstd::string collectionData
收藏数据
Definition: v2_nim_def_struct.hpp:1066

◆ addMessageListener()

virtual void v2::V2NIMMessageService::addMessageListener ( V2NIMMessageListener listener )

pure virtual

添加消息监听器

参数

listener 监听器

返回: void

示例代码: V2NIMMessageListener listener;

listener.onReceiveMessages = [](nstd::vector<V2NIMMessage> messages) {

// receive messages

};

listener.onReceiveP2PMessageReadReceipts = [](nstd::vector<V2NIMP2PMessageReadReceipt> readReceipts) {

// receive p2p message read receipts

};

listener.onReceiveTeamMessageReadReceipts = [](nstd::vector<V2NIMTeamMessageReadReceipt> readReceipts) {

// receive team message read receipts

};

listener.onMessageRevokeNotifications = [](nstd::vector<V2NIMMessageRevokeNotification> revokeNotifications) {

// receive message revoke notifications

};

listener.onMessagePinNotification = [](V2NIMMessagePinNotification pinNotification) {

// receive message pin notification

};

listener.onMessageQuickCommentNotification = [](V2NIMMessageQuickCommentNotification quickCommentNotification) {

// receive message quick comment notification

};

listener.onMessageDeletedNotifications = [](nstd::vector<V2NIMMessageDeletedNotification> messageDeletedNotification) {

// receive message deleted notifications

};

listener.onClearHistoryNotifications = [](nstd::vector<V2NIMClearHistoryNotification> clearHistoryNotification) {

// receive clear history notifications

};

messageService.addMessageListener(listener);

nstd::_continuous_container
Definition: ne_stl_continuous_container.h:15

v2::V2NIMMessageListener
Definition: v2_nim_def_callback.hpp:110

v2::V2NIMMessageListener::onMessageRevokeNotifications
nstd::function< void(nstd::vector< V2NIMMessageRevokeNotification > revokeNotifications)> onMessageRevokeNotifications
消息撤回
Definition: v2_nim_def_callback.hpp:118

v2::V2NIMMessageListener::onReceiveP2PMessageReadReceipts
nstd::function< void(nstd::vector< V2NIMP2PMessageReadReceipt > readReceipts)> onReceiveP2PMessageReadReceipts
点对点已读回执
Definition: v2_nim_def_callback.hpp:114

v2::V2NIMMessageListener::onMessageDeletedNotifications
nstd::function< void(nstd::vector< V2NIMMessageDeletedNotification > messageDeletedNotification)> onMessageDeletedNotifications
消息被删除
Definition: v2_nim_def_callback.hpp:124

v2::V2NIMMessageListener::onMessagePinNotification
nstd::function< void(V2NIMMessagePinNotification pinNotification)> onMessagePinNotification
消息 pin 状态
Definition: v2_nim_def_callback.hpp:120

v2::V2NIMMessageListener::onReceiveMessages
nstd::function< void(nstd::vector< V2NIMMessage > messages)> onReceiveMessages
收到一条新消息
Definition: v2_nim_def_callback.hpp:112

v2::V2NIMMessageListener::onReceiveTeamMessageReadReceipts
nstd::function< void(nstd::vector< V2NIMTeamMessageReadReceipt > readReceipts)> onReceiveTeamMessageReadReceipts
群已读回执
Definition: v2_nim_def_callback.hpp:116

v2::V2NIMMessageListener::onClearHistoryNotifications
nstd::function< void(nstd::vector< V2NIMClearHistoryNotification > clearHistoryNotification)> onClearHistoryNotifications
清空会话历史消息
Definition: v2_nim_def_callback.hpp:126

v2::V2NIMMessageListener::onMessageQuickCommentNotification
nstd::function< void(V2NIMMessageQuickCommentNotification quickCommentNotification)> onMessageQuickCommentNotification
消息快捷评论
Definition: v2_nim_def_callback.hpp:122

◆ addQuickComment()

virtual void v2::V2NIMMessageService::addQuickComment	(	V2NIMMessage	message,
		uint64_t	index,
		nstd::optional< nstd::string >	serverExtension,
		V2NIMMessageQuickCommentPushConfig	pushConfig,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

添加快捷评论

参数

message	要添加快捷评论的消息
index	快捷评论索引
serverExtension	服务器扩展字段
pushConfig	推送配置
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

V2NIMMessageQuickCommentPushConfig pushConfig;

messageService.addQuickComment(

message,

1,

"serverExtension",

pushConfig,

[]() {

// add quick comment succeeded

},

[](V2NIMError error) {

// add quick comment failed, handle error

});

v2::V2NIMMessage
Definition: v2_nim_def_struct.hpp:623

v2::V2NIMMessageQuickCommentPushConfig
Definition: v2_nim_def_struct.hpp:996

◆ cancelMessageAttachmentUpload()

virtual void v2::V2NIMMessageService::cancelMessageAttachmentUpload	(	V2NIMMessage	message,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

取消文件消息附件上传

参数

message	要取消上传的文件消息
success	成功回调, 返回取消上传的文件消息
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.cancelMessageAttachmentUpload(

message,

[]() {

// cancel message attachment upload succeeded

},

[](V2NIMError error) {

// cancel message attachment upload failed, handle error

});

◆ clearHistoryMessage()

virtual void v2::V2NIMMessageService::clearHistoryMessage	(	V2NIMClearHistoryMessageOption	option,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

清空历史消息

参数

option	清空历史消息配置选项
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMClearHistoryMessageOption option;

option.conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");

messageService.clearHistoryMessage(

option,

[]() {

// clear history message succeeded

},

[](V2NIMError error) {

// clear history message failed, handle error

});

v2::V2NIMClearHistoryMessageOption
Definition: v2_nim_def_struct.hpp:985

v2::V2NIMClearHistoryMessageOption::conversationId
nstd::string conversationId
需要清空消息的对应的会话 ID
Definition: v2_nim_def_struct.hpp:987

v2::V2NIMConversationIdUtil::p2pConversationId
static nstd::string p2pConversationId(const nstd::string &accountId)
获取点对点会话ID
Definition: v2_nim_internal.hpp:246

◆ deleteMessage()

virtual void v2::V2NIMMessageService::deleteMessage	(	V2NIMMessage	message,
		nstd::optional< nstd::string >	serverExtension,
		bool	onlyDeleteLocal,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

删除消息

参数

message	需要删除的消息
serverExtension	服务器扩展字段
onlyDeleteLocal	是否只删除本地消息
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.deleteMessage(

message,

"serverExtension",

false,

[]() {

// delete message succeeded

},

[](V2NIMError error) {

// delete message failed, handle error

});

◆ deleteMessages()

virtual void v2::V2NIMMessageService::deleteMessages	(	nstd::vector< V2NIMMessage >	messages,
		nstd::optional< nstd::string >	serverExtension,
		bool	onlyDeleteLocal,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

批量删除消息

参数

messages	需要删除的消息列表
serverExtension	服务器扩展字段
onlyDeleteLocal	是否只删除本地消息
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMMessage> messages

// ...

messageService.deleteMessages(

messages,

"serverExtension",

false,

[]() {

// delete messages succeeded

},

[](V2NIMError error) {

// delete messages failed, handle error

});

◆ getCollectionListByOption()

virtual void v2::V2NIMMessageService::getCollectionListByOption	(	V2NIMCollectionOption	option,
		V2NIMSuccessCallback< nstd::vector< V2NIMCollection > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

分页获取收藏列表

参数

option	获取收藏列表查询参数
success	成功回调, 返回收藏列表
failure	失败回调

返回: void

示例代码: V2NIMCollectionOption option;

option.collectionType = 1;

option.limit = 10;

messageService.getCollectionListByOption(

option,

[](nstd::vector<V2NIMCollection> collections) {

for (auto&& collection : collections) {

// do something

}

},

[](V2NIMError error) {

// get collection list failed, handle error

});

v2::V2NIMCollectionOption
Definition: v2_nim_def_struct.hpp:1071

v2::V2NIMCollectionOption::limit
uint32_t limit
每次查询收藏条数
Definition: v2_nim_def_struct.hpp:1081

v2::V2NIMCollectionOption::collectionType
uint32_t collectionType
收藏类型
Definition: v2_nim_def_struct.hpp:1083

◆ getLocalThreadMessageList()

virtual void v2::V2NIMMessageService::getLocalThreadMessageList	(	V2NIMMessageRefer	messageRefer,
		V2NIMSuccessCallback< V2NIMThreadMessageListResult >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

查询 thread 聊天本地消息列表

参数

V2NIMMessageRefer	messageRefer 消息查询选项
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessageRefer messageRefer;

// ...

messageService.getLocalThreadMessageList(

messageRefer,

[](V2NIMThreadMessageListResult response) {

// do something

},

[](V2NIMError error) {

// get message list by refers failed, handle error

});

v2::V2NIMMessageRefer
Definition: v2_nim_def_struct.hpp:524

v2::V2NIMThreadMessageListResult
Definition: v2_nim_def_struct.hpp:716

◆ getMessageList()

virtual void v2::V2NIMMessageService::getMessageList	(	V2NIMMessageListOption	option,
		V2NIMSuccessCallback< nstd::vector< V2NIMMessage > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

查询消息

参数

option	查询消息配置选项
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessageListOption option;

option.limit = 10;

messageService.getMessageList(

option,

[](nstd::vector<V2NIMMessage> messages) {

for (auto&& message : messages) {

// do something

}

},

[](V2NIMError error) {

// get message list failed, handle error

});

v2::V2NIMMessageListOption
Definition: v2_nim_def_struct.hpp:964

v2::V2NIMMessageListOption::limit
uint32_t limit
查询条数
Definition: v2_nim_def_struct.hpp:974

◆ getMessageListByIds()

virtual void v2::V2NIMMessageService::getMessageListByIds	(	nstd::vector< nstd::string >	messageClientIds,
		V2NIMSuccessCallback< nstd::vector< V2NIMMessage > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据 ID 列表查询消息

参数

messageClientIds	消息客户端 ID 列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<nstd::string> messageClientIds;

// ...

messageService.getMessageListByIds(

messageClientIds,

[](nstd::vector<V2NIMMessage> messages) {

for (auto&& message : messages) {

// do something

}

},

[](V2NIMError error) {

// get message list by ids failed, handle error

});

◆ getMessageListByRefers()

virtual void v2::V2NIMMessageService::getMessageListByRefers	(	nstd::vector< V2NIMMessageRefer >	messageRefers,
		V2NIMSuccessCallback< nstd::vector< V2NIMMessage > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

根据消息引用列表查询消息

参数

messageRefers	消息引用列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMMessageRefer> messageRefers;

// ...

messageService.getMessageListByRefers(

messageRefers,

[](nstd::vector<V2NIMMessage> messages) {

for (auto&& message : messages) {

// do something

}

},

[](V2NIMError error) {

// get message list by refers failed, handle error

});

◆ getP2PMessageReceipt()

virtual void v2::V2NIMMessageService::getP2PMessageReceipt	(	nstd::string	conversationId,
		V2NIMSuccessCallback< V2NIMP2PMessageReadReceipt >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

查询 P2P 消息已读回执状态

参数

conversationId	会话 ID
success	成功回调
failure	失败回调

返回: void

示例代码: auto conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");

messageService.getP2PMessageReceipt(

conversationId,

[](V2NIMP2PMessageReadReceipt receipt) {

// get p2p message receipt succeeded

},

[](V2NIMError error) {

// get p2p message receipt failed, handle error

});

v2::V2NIMP2PMessageReadReceipt
Definition: v2_nim_def_struct.hpp:950

◆ getPinnedMessageList()

virtual void v2::V2NIMMessageService::getPinnedMessageList	(	nstd::string	conversationId,
		V2NIMSuccessCallback< nstd::vector< V2NIMMessagePin > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取 pin 消息列表

参数

conversationId	会话 ID
success	成功回调
failure	失败回调

返回: void

示例代码: auto conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");

messageService.getPinnedMessageList(

conversationId,

[](nstd::vector<V2NIMMessagePin> pins) {

for (auto&& pin : pins) {

// do something

}

},

[](V2NIMError error) {

// get pin message list failed, handle error

});

◆ getQuickCommentList()

virtual void v2::V2NIMMessageService::getQuickCommentList	(	nstd::vector< V2NIMMessage >	messages,
		V2NIMSuccessCallback< nstd::map< nstd::string, nstd::vector< V2NIMMessageQuickComment > > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取快捷评论列表

参数

messages	要获取快捷评论的消息列表
success	成功回调, key: 消息客户端 ID, value: 快捷评论列表
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMMessage> messages

// ...

messageService.getQuickCommentList(

messages,

[](nstd::map<nstd::string, nstd::vector<V2NIMMessageQuickComment>> quickComments) {

for (auto&& quickComment : quickComments) {

// do something

}

},

[](V2NIMError error) {

// get quick comment list failed, handle error

});

nstd::map
Definition: ne_stl_map.h:15

nstd::_string
Definition: ne_stl_string.h:19

◆ getTeamMessageReceiptDetail()

virtual void v2::V2NIMMessageService::getTeamMessageReceiptDetail	(	V2NIMMessage	message,
		nstd::set< nstd::string >	memberAccountIds,
		V2NIMSuccessCallback< V2NIMTeamMessageReadReceiptDetail >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取群消息已读回执详情

参数

message	要查询的消息
memberAccountIds	指定的账号列表, 为空表示查询全部
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.getTeamMessageReceiptDetail(

message,

{},

[](V2NIMTeamMessageReadReceiptDetail readReceiptDetial) {

// get team message receipt detail succeeded

},

[](V2NIMError error) {

// get team message receipt detail failed, handle error

});

v2::V2NIMTeamMessageReadReceiptDetail
Definition: v2_nim_def_struct.hpp:941

◆ getTeamMessageReceipts()

virtual void v2::V2NIMMessageService::getTeamMessageReceipts	(	nstd::vector< V2NIMMessage >	messages,
		V2NIMSuccessCallback< nstd::vector< V2NIMTeamMessageReadReceipt > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

获取群消息已读回执状态

参数

messages	要查询的消息列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMMessage> messages;

// ...

messageService.getTeamMessageReceipts(

messages,

[](nstd::vector<V2NIMTeamMessageReadReceipt> receipts) {

for (auto&& receipt : receipts) {

// do something

}

},

[](V2NIMError error) {

// get team message receipts failed, handle error

});

◆ getThreadMessageList()

virtual void v2::V2NIMMessageService::getThreadMessageList	(	V2NIMThreadMessageListOption	threadMessageListOption,
		V2NIMSuccessCallback< V2NIMThreadMessageListResult >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

查询 thread 聊天云端消息列表

参数

V2NIMThreadMessageListOption	threadMessageListOption 消息查询选项
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMThreadMessageListOption threadMessageListOption;

// ...

messageService.getThreadMessageList(

threadMessageListOption,

[](V2NIMThreadMessageListResult response) {

// do something

},

[](V2NIMError error) {

// get message list by refers failed, handle error

});

v2::V2NIMThreadMessageListOption
Definition: v2_nim_def_struct.hpp:541

◆ insertMessageToLocal()

virtual void v2::V2NIMMessageService::insertMessageToLocal	(	V2NIMMessage	message,
		nstd::string	conversationId,
		nstd::string	senderId,
		uint64_t	createTime,
		V2NIMSuccessCallback< V2NIMMessage >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

插入本地消息

参数

message	要插入的消息
conversationId	会话 ID
senderId	发送者 ID, 传空表示当前用户
createTime	消息创建时间, 0 表示不覆盖消息时间
success	成功回调
failure	失败回调

返回: void

示例代码: auto conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");

auto message = V2NIMMessageCreator::createTextMessage("hello world");

messageService.insertMessageToLocal(

message,

conversationId,

"target_account_id",

0,

[](V2NIMMessage message) {

// insert local message succeeded

},

[](V2NIMError error) {

// insert local message failed, handle error

});

v2::V2NIMMessageCreator::createTextMessage
static nstd::optional< V2NIMMessage > createTextMessage(nstd::string text)
创建文本消息
Definition: v2_nim_internal.hpp:144

◆ isPeerRead()

virtual bool v2::V2NIMMessageService::isPeerRead ( V2NIMMessage message )

pure virtual

查询 P2P 消息对方是否已读

参数

message	要查询的消息
success	成功回调
failure	失败回调

返回: bool 是否已读

示例代码: V2NIMMessage message;

// ...

bool peerRead = messageService.isPeerRead(message);

◆ modifyMessage()

virtual void v2::V2NIMMessageService::modifyMessage	(	const V2NIMMessage &	message,
		const V2NIMModifyMessageParams &	params,
		const V2NIMSuccessCallback< const V2NIMModifyMessageResult & > &	success,
		const V2NIMFailureCallback &	failure
	)

pure virtual

更新消息

参数

message	需要修改的消息体
params	修改消息相关配置参数
success	成功回调
failure	失败回调

返回: void

示例代码: auto params = V2NIMModifyMessageParams();

messageService.modifyMessage(

message,

params,

[](V2NIMModifyMessageResult result) {

// modify message succeeded

},

[](V2NIMError error) {

// modify message failed, handle error

});

v2::V2NIMModifyMessageParams
Definition: v2_nim_def_struct.hpp:695

v2::V2NIMModifyMessageResult
Definition: v2_nim_def_struct.hpp:915

◆ pinMessage()

virtual void v2::V2NIMMessageService::pinMessage	(	V2NIMMessage	message,
		nstd::optional< nstd::string >	serverExtension,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

pin 消息

参数

message	要 pin 的消息
serverExtension	扩展字段
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.pinMessage(

message,

"serverExtension",

[]() {

// pin message succeeded

},

[](V2NIMError error) {

// pin message failed, handle error

});

◆ removeCollections()

virtual void v2::V2NIMMessageService::removeCollections	(	nstd::vector< V2NIMCollection >	collections,
		V2NIMSuccessCallback< uint32_t >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

移除收藏

参数

collections	要移除的收藏列表
success	成功回调, 返回移除的收藏数量
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMCollection> collections;

// ...

messageService.removeCollections(

collections,

[](uint32_t count) {

// remove collection succeeded

},

[](V2NIMError error) {

// remove collection failed, handle error

});

◆ removeMessageListener()

virtual void v2::V2NIMMessageService::removeMessageListener ( V2NIMMessageListener listener )

pure virtual

移除消息监听器

返回: void

示例代码: V2NIMMessageListener listener;

// ...

conversationService.addMessageListener(listener);

// ...

messageService.removeMessageListener(listener);

◆ removeQuickComment()

virtual void v2::V2NIMMessageService::removeQuickComment	(	V2NIMMessageRefer	messageRefer,
		uint32_t	index,
		nstd::optional< nstd::string >	serverExtension,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

移除快捷评论

参数

messageRefer	要移除快捷评论的消息引用
index	快捷评论索引
serverExtension	服务器扩展字段
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessageRefer messageRefer;

// ...

messageService.removeQuickComment(

messageRefer,

1,

"serverExtension",

[]() {

// remove quick comment succeeded

},

[](V2NIMError error) {

// remove quick comment failed, handle error

});

◆ replyMessage()

virtual void v2::V2NIMMessageService::replyMessage	(	V2NIMMessage	message,
		V2NIMMessage	replyMessage,
		V2NIMSendMessageParams	params,
		V2NIMSuccessCallback< V2NIMSendMessageResult >	success,
		V2NIMFailureCallback	failure,
		V2NIMProgressCallback	progress
	)

pure virtual

回复消息

参数

message	要发送的消息
replyMessage	被回复的消息
params	发送参数
success	成功回调
failure	失败回调
progress	附件上传进度回调

返回: void

示例代码: auto message = V2NIMMessageCreator::createTextMessage("hello world");

auto params = V2NIMSendMessageParams();

messageService.replyMessage(

message,

replyMessage,

params,

[](V2NIMSendMessageResult result) {

// reply message succeeded

},

[](V2NIMError error) {

// reply message failed, handle error

},

[](uint32_t progress) {

// upload progress

});

v2::V2NIMSendMessageParams
Definition: v2_nim_def_struct.hpp:819

v2::V2NIMSendMessageResult
Definition: v2_nim_def_struct.hpp:906

v2::V2NIMMessageService::replyMessage
virtual void replyMessage(V2NIMMessage message, V2NIMMessage replyMessage, V2NIMSendMessageParams params, V2NIMSuccessCallback< V2NIMSendMessageResult > success, V2NIMFailureCallback failure, V2NIMProgressCallback progress)=0
回复消息

◆ revokeMessage()

virtual void v2::V2NIMMessageService::revokeMessage	(	V2NIMMessage	message,
		V2NIMMessageRevokeParams	params,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

撤回消息

参数

message	要撤回的消息
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

V2NIMMessageRevokeParams params;

messageService.revokeMessage(

message,

params,

[]() {

// revoke message succeeded

},

[](V2NIMError error) {

// revoke message failed, handle error

});

v2::V2NIMMessageRevokeParams
Definition: v2_nim_def_struct.hpp:840

◆ searchCloudMessages()

virtual void v2::V2NIMMessageService::searchCloudMessages	(	V2NIMMessageSearchParams	params,
		V2NIMSuccessCallback< nstd::vector< V2NIMMessage > >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

搜索云端消息

参数

params	消息检索参数
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessageSearchParams params;

params.keyword = "keyword";

params.messageLimit = 20;

messageService.searchCloudMessages(

params,

[](nstd::vector<V2NIMMessage> messages) {

for (auto&& message : messages) {

// do something

}

},

[](V2NIMError error) {

// search cloud messages failed, handle error

});

v2::V2NIMMessageSearchParams
Definition: v2_nim_def_struct.hpp:1283

v2::V2NIMMessageSearchParams::messageLimit
uint32_t messageLimit
返回消息数量
Definition: v2_nim_def_struct.hpp:1293

v2::V2NIMMessageSearchParams::keyword
nstd::string keyword
关键字
Definition: v2_nim_def_struct.hpp:1285

◆ sendMessage()

virtual void v2::V2NIMMessageService::sendMessage	(	V2NIMMessage	message,
		nstd::string	conversationId,
		V2NIMSendMessageParams	params,
		V2NIMSuccessCallback< V2NIMSendMessageResult >	success,
		V2NIMFailureCallback	failure,
		V2NIMProgressCallback	progress
	)

pure virtual

发送消息

参数

message	要发送的消息
conversationId	发送目标会话
params	发送参数
success	成功回调
failure	失败回调
progress	附件上传进度回调

返回: void

示例代码: auto conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");

auto message = V2NIMMessageCreator::createTextMessage("hello world");

auto params = V2NIMSendMessageParams();

messageService.sendMessage(

message,

conversationId,

params,

[](V2NIMSendMessageResult result) {

// send message succeeded

},

[](V2NIMError error) {

// send message failed, handle error

},

[](uint32_t progress) {

// upload progress

});

◆ sendP2PMessageReceipt()

virtual void v2::V2NIMMessageService::sendP2PMessageReceipt	(	V2NIMMessage	message,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

发送 P2P 消息已读回执

参数

message	要发送已读回执的消息
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.sendP2PMessageReceipt(

message,

[]() {

// send p2p message receipt succeeded

},

[](V2NIMError error) {

// send p2p message receipt failed, handle error

});

◆ sendTeamMessageReceipts()

virtual void v2::V2NIMMessageService::sendTeamMessageReceipts	(	nstd::vector< V2NIMMessage >	messages,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

发送群消息已读回执

参数

messages	要发送已读回执的消息列表
success	成功回调
failure	失败回调

返回: void

示例代码: nstd::vector<V2NIMMessage> messages;

// ...

messageService.sendTeamMessageReceipts(

messages,

[]() {

// send team message receipts succeeded

},

[](V2NIMError error) {

// send team message receipts failed, handle error

});

◆ unpinMessage()

virtual void v2::V2NIMMessageService::unpinMessage	(	V2NIMMessageRefer	messageRefer,
		nstd::optional< nstd::string >	serverExtension,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

取消 pin 消息

参数

messageRefer	要 unpin 的消息引用
serverExtension	扩展字段
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessageRefer messageRefer;

// ...

messageService.unpinMessage(

messageRefer,

"serverExtension",

[]() {

// unpin message succeeded

},

[](V2NIMError error) {

// unpin message failed, handle error

});

◆ updateCollectionExtension()

virtual void v2::V2NIMMessageService::updateCollectionExtension	(	V2NIMCollection	collection,
		nstd::optional< nstd::string >	serverExtension,
		V2NIMSuccessCallback< V2NIMCollection >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

更新收藏扩展字段

参数

collection	要更新的收藏
serverExtension	服务器扩展字段, 传空表示删除扩展字段
success	成功回调, 返回更新后的收藏
failure	失败回调

返回: void

示例代码: V2NIMCollection collection

// ...

messageService.updateCollectionExtension(

collection,

"serverExtension",

[](V2NIMCollection collection) {

// update collection succeeded

},

[](V2NIMError error) {

// update collection failed, handle error

});

◆ updateMessageLocalExtension()

virtual void v2::V2NIMMessageService::updateMessageLocalExtension	(	V2NIMMessage	message,
		nstd::string	localExtension,
		V2NIMSuccessCallback< V2NIMMessage >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

更新消息本地扩展

参数

message	要更新的消息
localExtension	本地扩展字段
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.updateMessageLocalExtension(

message,

"localExtension",

[](V2NIMMessage message) {

// update message local extension succeeded

},

[](V2NIMError error) {

// update message local extension failed, handle error

});

◆ updatePinMessage()

virtual void v2::V2NIMMessageService::updatePinMessage	(	V2NIMMessage	message,
		nstd::optional< nstd::string >	serverExtension,
		V2NIMSuccessCallback< void >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

更新 pin 消息

参数

message	要更新的 pin 消息
serverExtension	扩展字段
success	成功回调
failure	失败回调

返回: void

示例代码: V2NIMMessage message;

// ...

messageService.updatePinMessage(

message,

"serverExtension",

[]() {

// update pin message succeeded

},

[](V2NIMError error) {

// update pin message failed, handle error

});

◆ voiceToText()

virtual void v2::V2NIMMessageService::voiceToText	(	V2NIMVoiceToTextParams	params,
		V2NIMSuccessCallback< nstd::string >	success,
		V2NIMFailureCallback	failure
	)

pure virtual

语音转文字

参数

params 语音转文字参数

返回: void

示例代码: V2NIMVoiceToTextParams params,

params.voiceUrl = "voice_url";

params.mimeType = "aac";

params.duration = "1000";

messageService.voiceToText(

params,

[](nstd::string text) {

// translate voice to text succeeded

},

[](V2NIMError error) {

// translate voice to text failed, handle error

});

v2::V2NIMVoiceToTextParams
Definition: v2_nim_def_struct.hpp:1308

v2::V2NIMVoiceToTextParams::voiceUrl
nstd::string voiceUrl
语音 url, 若为空则根据 voicePath 自动上传
Definition: v2_nim_def_struct.hpp:1312

v2::V2NIMVoiceToTextParams::mimeType
nstd::string mimeType
音频类型, aac, wav, mp3, amr等
Definition: v2_nim_def_struct.hpp:1314

v2::V2NIMVoiceToTextParams::duration
uint64_t duration
语音时长, 单位毫秒
Definition: v2_nim_def_struct.hpp:1318

该类的文档由以下文件生成:

D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/include/v2_nim_message_service.hpp

Public 成员函数

详细描述

成员函数说明

◆ addCollection()

◆ addMessageListener()

◆ addQuickComment()

◆ cancelMessageAttachmentUpload()

◆ clearHistoryMessage()

◆ deleteMessage()

◆ deleteMessages()

◆ getCollectionListByOption()

◆ getLocalThreadMessageList()

◆ getMessageList()

◆ getMessageListByIds()

◆ getMessageListByRefers()

◆ getP2PMessageReceipt()

◆ getPinnedMessageList()

◆ getQuickCommentList()

◆ getTeamMessageReceiptDetail()

◆ getTeamMessageReceipts()

◆ getThreadMessageList()

◆ insertMessageToLocal()

◆ isPeerRead()

◆ modifyMessage()

◆ pinMessage()

◆ removeCollections()

◆ removeMessageListener()

◆ removeQuickComment()

◆ replyMessage()

◆ revokeMessage()

◆ searchCloudMessages()

◆ sendMessage()

◆ sendP2PMessageReceipt()

◆ sendTeamMessageReceipts()

◆ unpinMessage()

◆ updateCollectionExtension()

◆ updateMessageLocalExtension()

◆ updatePinMessage()

◆ voiceToText()