NIMSDK-AOS  10.9.76
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.v2.message.V2NIMMessageService接口 参考

Public 成员函数

void sendMessage (V2NIMMessage message, String conversationId, V2NIMSendMessageParams params, V2NIMSuccessCallback< V2NIMSendMessageResult > success, V2NIMFailureCallback failure, V2NIMProgressCallback progress)
 发送消息接口 主要运用于文件类消息,回调文件发送进度 更多...
 
void stopAIStreamMessage (V2NIMMessage message, V2NIMMessageAIStreamStopParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 停止流式消息输出 更多...
 
void regenAIMessage (V2NIMMessage message, V2NIMMessageAIRegenParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 重新输出数字人消息 更多...
 
void replyMessage (V2NIMMessage message, V2NIMMessage replyMessage, V2NIMSendMessageParams params, V2NIMSuccessCallback< V2NIMSendMessageResult > success, V2NIMFailureCallback failure, V2NIMProgressCallback progress)
 回复消息 更多...
 
void revokeMessage (V2NIMMessage message, V2NIMMessageRevokeParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 撤回单条消息 如果被删除消息未发送成功, 则只删除本地消息 删除本地消息不会多端同步,删除云端会多端同步 更多...
 
void getMessageList (V2NIMMessageListOption option, V2NIMSuccessCallback< List< V2NIMMessage >> success, V2NIMFailureCallback failure)
 查询历史消息 分页接口,每次默认50条,可以根据参数组合查询各种类型 更多...
 
V2NIMSyncResult< List< V2NIMMessage > > getMessageList (V2NIMMessageListOption option)
 查询历史消息 同步接口只支持查询本地数据(忽略V2NIMMessageListOption中的onlyQueryLocal参数) 更多...
 
void getMessageListEx (V2NIMMessageListOption option, V2NIMSuccessCallback< V2NIMMessageListResult > success, V2NIMFailureCallback failure)
 查询历史消息 分页接口,每次默认50条,可以根据参数组合查询各种类型 更多...
 
void getCloudMessageList (V2NIMCloudMessageListOption option, V2NIMSuccessCallback< V2NIMMessageListResult > success, V2NIMFailureCallback failure)
 查询云端消息 更多...
 
void getMessageListByIds (List< String > messageClientIds, V2NIMSuccessCallback< List< V2NIMMessage >> success, V2NIMFailureCallback failure)
 根据ID列表查询消息 只查询本地数据库 更多...
 
V2NIMSyncResult< List< V2NIMMessage > > getMessageListByIds (List< String > messageClientIds, String conversationId)
 根据ID列表查询消息 只查询本地数据库 更多...
 
void getMessageListByRefers (List< V2NIMMessageRefer > messageRefers, V2NIMSuccessCallback< List< V2NIMMessage >> success, V2NIMFailureCallback failure)
 根据MessageRefer列表查询消息 先查询本地数据库, 不存在查询已有协议(23-2) 如果本地数据已经存在, 则直接返回成功 如果本地数据不存在或者不全, 则服务器查询缺失数据 如果服务器协议层失败, 则直接返回失败 如果服务器内容部分失败, 则返回成功列表数据 更多...
 
void deleteMessage (V2NIMMessage message, String serverExtension, boolean onlyDeleteLocal, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 删除单条消息 如果被删除消息未发送成功, 则只删除本地消息 删除本地消息不会多端同步,删除云端会多端同步 更多...
 
void deleteMessages (List< V2NIMMessage > messages, String serverExtension, boolean onlyDeleteLocal, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 批量删除消息 如果被删除消息未发送成功, 则只删除本地消息 所有消息必须属于同一个会话 每次最多50条消息,超过50条返回参数错误 删除本地消息不会多端同步,删除云端会多端同步 不考虑部分删除失败的情况 更多...
 
void clearHistoryMessage (V2NIMClearHistoryMessageOption option, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 清空历史消息 同步删除本地消息,云端消息 会话不会被删除, 如果需要删除会话,请调用删除会话接口 更多...
 
void clearRoamingMessage (List< String > conversationIds, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 仅清空会话漫游消息, 单次传递最多50个会话ID 更多...
 
void updateMessageLocalExtension (V2NIMMessage message, String localExtension, V2NIMSuccessCallback< V2NIMMessage > success, V2NIMFailureCallback failure)
 更新消息本地扩展字段 更多...
 
void updateLocalMessage (V2NIMMessage message, V2NIMUpdateLocalMessageParams params, V2NIMSuccessCallback< V2NIMMessage > success, V2NIMFailureCallback failure)
 更新本地插入的消息 serverid为0的消息 云端消息请调用modifyMessage接口 更多...
 
void insertMessageToLocal (V2NIMMessage message, String conversationId, String senderId, long createTime, V2NIMSuccessCallback< V2NIMMessage > success, V2NIMFailureCallback failure)
 插入一条本地消息, 该消息不会发送 该消息不会多端同步,只是本端显示 插入成功后, SDK会抛出回调 Web端不支持该接口 更多...
 
void insertMessageToLocalEx (V2NIMMessage message, V2NIMMessageInsertParams params, V2NIMSuccessCallback< V2NIMMessage > success, V2NIMFailureCallback failure)
 插入一条本地消息(扩展版),该消息不会发送 更多...
 
void pinMessage (V2NIMMessage message, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 Pin一条消息 Pin成功后,SDK会抛出回调 更多...
 
void unpinMessage (V2NIMMessageRefer messageRefer, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 取消一条Pin消息 更多...
 
void updatePinMessage (V2NIMMessage message, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 更新一条 Pin 消息 更多...
 
void getPinnedMessageList (String conversationId, V2NIMSuccessCallback< List< V2NIMMessagePin >> success, V2NIMFailureCallback failure)
 获取 pin 消息列表 更多...
 
void addQuickComment (V2NIMMessage message, long index, String serverExtension, V2NIMMessageQuickCommentPushConfig pushConfig, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 添加快捷评论 更多...
 
void removeQuickComment (V2NIMMessageRefer messageRefer, long index, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 移除快捷评论 更多...
 
void getQuickCommentList (List< V2NIMMessage > messages, V2NIMSuccessCallback< Map< String, List< V2NIMMessageQuickComment >>> success, V2NIMFailureCallback failure)
 获取快捷评论列表 更多...
 
void addCollection (V2NIMAddCollectionParams params, V2NIMSuccessCallback< V2NIMCollection > success, V2NIMFailureCallback failure)
 添加一个收藏 可以收藏消息, 也可以收藏其他自定义内容 后续可能会移动到另外单独服务中, 它与消息不绑定 更多...
 
void removeCollections (List< V2NIMCollection > collections, V2NIMSuccessCallback< Integer > success, V2NIMFailureCallback failure)
 添加一个收藏 可以收藏消息, 也可以收藏其他自定义内容 后续可能会移动到另外单独服务中, 它与消息不绑定 更多...
 
void updateCollectionExtension (V2NIMCollection collection, String serverExtension, V2NIMSuccessCallback< V2NIMCollection > success, V2NIMFailureCallback failure)
 更新收藏扩展字段 更多...
 
void getCollectionListByOption (V2NIMCollectionOption option, V2NIMSuccessCallback< List< V2NIMCollection >> success, V2NIMFailureCallback failure)
 按条件分页获取收藏信息 更多...
 
void getCollectionListExByOption (V2NIMCollectionOption option, V2NIMSuccessCallback< V2NIMCollectionListResult > success, V2NIMFailureCallback failure)
 按条件分页获取收藏信息。回调结果包含总条数 更多...
 
void sendP2PMessageReceipt (V2NIMMessage message, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 发送消息已读回执 更多...
 
void getP2PMessageReceipt (String conversationId, V2NIMSuccessCallback< V2NIMP2PMessageReadReceipt > success, V2NIMFailureCallback failure)
 查询点对点消息已读回执 更多...
 
boolean isPeerRead (V2NIMMessage message)
 查询点对点消息是否对方已读 内部判断逻辑为: 消息时间小于对方已读回执时间都为true 更多...
 
void sendTeamMessageReceipts (List< V2NIMMessage > messages, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 发送消息已读回执 所有消息必须属于同一个会话,否则返回 191001 使用姿势错误 更多...
 
void getTeamMessageReceipts (List< V2NIMMessage > messages, V2NIMSuccessCallback< List< V2NIMTeamMessageReadReceipt >> success, V2NIMFailureCallback failure)
 获取群消息已读回执状态 所有消息必须属于同一个会话,否则返回 191001 使用姿势错误 单次消息数量上限50 只返回存在且有效的消息的已读回执 更多...
 
void getTeamMessageReceiptDetail (V2NIMMessage message, Set< String > memberAccountIds, V2NIMSuccessCallback< V2NIMTeamMessageReadReceiptDetail > success, V2NIMFailureCallback failure)
 获取群消息已读回执状态详情 更多...
 
void voiceToText (V2NIMVoiceToTextParams params, V2NIMSuccessCallback< String > success, V2NIMFailureCallback failure)
 语音转文字 更多...
 
void cancelMessageAttachmentUpload (V2NIMMessage message, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 取消文件类附件上传,只有文件类消息可以调用该接口 如果文件已经上传成功,则取消失败 如果取消成功, 则对应消息文件上传状态会变成V2NIMMessageAttachmentUploadState.V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_FAILED,同时消息会发送失败 更多...
 
void searchCloudMessages (V2NIMMessageSearchParams params, V2NIMSuccessCallback< List< V2NIMMessage >> success, V2NIMFailureCallback failure)
 搜索云端消息 更多...
 
void searchCloudMessagesEx (V2NIMMessageSearchExParams params, V2NIMSuccessCallback< V2NIMMessageSearchResult > success, V2NIMFailureCallback failure)
 搜索云端消息 更多...
 
void searchLocalMessages (V2NIMMessageSearchExParams params, V2NIMSuccessCallback< V2NIMMessageSearchResult > success, V2NIMFailureCallback failure)
 检索本地消息 更多...
 
void getThreadMessageList (V2NIMThreadMessageListOption threadMessageListOption, V2NIMSuccessCallback< V2NIMThreadMessageListResult > success, V2NIMFailureCallback failure)
 查询thread聊天云端消息列表 更多...
 
void getLocalThreadMessageList (V2NIMMessageRefer messageRefer, V2NIMSuccessCallback< V2NIMThreadMessageListResult > success, V2NIMFailureCallback failure)
 查询thread聊天本地消息列表 更多...
 
void modifyMessage (V2NIMMessage message, V2NIMModifyMessageParams params, V2NIMSuccessCallback< V2NIMModifyMessageResult > success, V2NIMFailureCallback failure)
 更新消息 更多...
 
void registerCustomAttachmentParser (V2NIMMessageCustomAttachmentParser parser)
 注册自定义消息附件解析器,解析自定义消息类型为100的附件 后注册的解析器优先于先注册的解析器 更多...
 
void unregisterCustomAttachmentParser (V2NIMMessageCustomAttachmentParser parser)
 取消注册自定义消息附件解析器 更多...
 
void setMessageFilter (V2NIMMessageFilter filter)
 安装消息过滤器 更多...
 
void importMessagesToLocal (List< V2NIMMessage > messages, V2NIMImportMessagesToLocalOption option, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 批量导入本地消息 更多...
 
void clearLocalMessage (V2NIMClearLocalMessageParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 清空本地消息 更多...
 
void translateText (V2NIMTextTranslateParams params, V2NIMSuccessCallback< V2NIMTextTranslationResult > success, V2NIMFailureCallback failure)
 文本翻译接口,支持将原始文本翻译为指定语言 使用时需要控制台开通文本翻译功能 更多...
 
void addMessageListener (V2NIMMessageListener listener)
 添加消息监听 更多...
 
void removeMessageListener (V2NIMMessageListener listener)
 移除消息监听 更多...
 

详细描述

在文件 V2NIMMessageService.java39 行定义.

成员函数说明

void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.addCollection ( V2NIMAddCollectionParams  params,
V2NIMSuccessCallback< V2NIMCollection success,
V2NIMFailureCallback  failure 
)

添加一个收藏 可以收藏消息, 也可以收藏其他自定义内容 后续可能会移动到另外单独服务中, 它与消息不绑定

参数
params添加收藏相关参数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.addMessageListener ( V2NIMMessageListener  listener)

添加消息监听

参数
listener消息监听回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.addQuickComment ( V2NIMMessage  message,
long  index,
String  serverExtension,
V2NIMMessageQuickCommentPushConfig  pushConfig,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

添加快捷评论

参数
message被快捷评论的消息
index快捷评论索引,可以自定义映射关系,例如 表情回复: 可以本地构造映射关系, 1:笑脸 2:大笑, 当前读取到对应的index后,界面展示可以替换对应的表情 还可以应用于其他场景, 文本快捷回复等 大于 0
serverExtension扩展字段, 最大8个字符
pushConfig快捷评论推送配置
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.cancelMessageAttachmentUpload ( V2NIMMessage  message,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

取消文件类附件上传,只有文件类消息可以调用该接口 如果文件已经上传成功,则取消失败 如果取消成功, 则对应消息文件上传状态会变成V2NIMMessageAttachmentUploadState.V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_FAILED,同时消息会发送失败

参数
message需要取消附件上传的消息体
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.clearHistoryMessage ( V2NIMClearHistoryMessageOption  option,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

清空历史消息 同步删除本地消息,云端消息 会话不会被删除, 如果需要删除会话,请调用删除会话接口

参数
option清空消息参数,清空参数不能为空 必填
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.clearLocalMessage ( V2NIMClearLocalMessageParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

清空本地消息

参数
params清空本地消息参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.clearRoamingMessage ( List< String >  conversationIds,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

仅清空会话漫游消息, 单次传递最多50个会话ID

参数
conversationIds会话ID列表
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.deleteMessage ( V2NIMMessage  message,
String  serverExtension,
boolean  onlyDeleteLocal,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

删除单条消息 如果被删除消息未发送成功, 则只删除本地消息 删除本地消息不会多端同步,删除云端会多端同步

参数
message需要删除的消息
serverExtension扩展字段, 会多端同步到其他的登录端
onlyDeleteLocal是否只删除本地消息 true:只删除本地,本地会将该消息标记为删除, getMessageList会过滤该消息,界面不展示,卸载重装会再次显示 false:同时删除云端, 删除后消息不能恢复
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.deleteMessages ( List< V2NIMMessage messages,
String  serverExtension,
boolean  onlyDeleteLocal,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

批量删除消息 如果被删除消息未发送成功, 则只删除本地消息 所有消息必须属于同一个会话 每次最多50条消息,超过50条返回参数错误 删除本地消息不会多端同步,删除云端会多端同步 不考虑部分删除失败的情况

参数
messages需要删除的消息列表
serverExtension扩展字段, 会多端同步到其他的登录端
onlyDeleteLocal是否只删除本地消息 true:只删除本地,本地会将该消息标记为删除, getMessageList会过滤该消息,界面不展示,卸载重装会再次显示 false:同时删除云端, 删除后消息不能恢复
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getCloudMessageList ( V2NIMCloudMessageListOption  option,
V2NIMSuccessCallback< V2NIMMessageListResult success,
V2NIMFailureCallback  failure 
)

查询云端消息

参数
option查询消息配置选项
success查询成功回调,返回V2NIMMessageListResult,携带下页的消息锚点
failure查询失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getCollectionListByOption ( V2NIMCollectionOption  option,
V2NIMSuccessCallback< List< V2NIMCollection >>  success,
V2NIMFailureCallback  failure 
)

按条件分页获取收藏信息

参数
option查询参数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getCollectionListExByOption ( V2NIMCollectionOption  option,
V2NIMSuccessCallback< V2NIMCollectionListResult success,
V2NIMFailureCallback  failure 
)

按条件分页获取收藏信息。回调结果包含总条数

参数
option查询参数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getLocalThreadMessageList ( V2NIMMessageRefer  messageRefer,
V2NIMSuccessCallback< V2NIMThreadMessageListResult success,
V2NIMFailureCallback  failure 
)

查询thread聊天本地消息列表

参数
messageRefer根消息引用
success查询成功回调
failure查询失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getMessageList ( V2NIMMessageListOption  option,
V2NIMSuccessCallback< List< V2NIMMessage >>  success,
V2NIMFailureCallback  failure 
)

查询历史消息 分页接口,每次默认50条,可以根据参数组合查询各种类型

参数
option查询消息配置选项
success查询成功回调, 返回查询到的消息列表
failure查询失败回调
V2NIMSyncResult<List<V2NIMMessage> > com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getMessageList ( V2NIMMessageListOption  option)

查询历史消息 同步接口只支持查询本地数据(忽略V2NIMMessageListOption中的onlyQueryLocal参数)

同步接口,存在数据库查询操作,请勿在UI线程调用

参数
option查询消息配置选项,同步接口只支持查询本地数据
返回
查询结果
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getMessageListByIds ( List< String >  messageClientIds,
V2NIMSuccessCallback< List< V2NIMMessage >>  success,
V2NIMFailureCallback  failure 
)

根据ID列表查询消息 只查询本地数据库

参数
messageClientIds需要查询的消息客户端ID列表 若为空,或者数量为0,返回参数错误
success发送消息成功回调
failure发送消息失败回调
V2NIMSyncResult<List<V2NIMMessage> > com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getMessageListByIds ( List< String >  messageClientIds,
String  conversationId 
)

根据ID列表查询消息 只查询本地数据库

同步接口,存在数据库查询操作,请勿在UI线程调用

参数
messageClientIds需要查询的消息客户端ID列表 若为空,或者数量为0,返回参数错误
conversationId会话ID, 可为空,如果传入null,则不限定会话查找
返回
查询结果
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getMessageListByRefers ( List< V2NIMMessageRefer messageRefers,
V2NIMSuccessCallback< List< V2NIMMessage >>  success,
V2NIMFailureCallback  failure 
)

根据MessageRefer列表查询消息 先查询本地数据库, 不存在查询已有协议(23-2) 如果本地数据已经存在, 则直接返回成功 如果本地数据不存在或者不全, 则服务器查询缺失数据 如果服务器协议层失败, 则直接返回失败 如果服务器内容部分失败, 则返回成功列表数据

参数
messageRefers需要查询的消息Refer列表 若为空,或者数量为0,返回参数错误
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getMessageListEx ( V2NIMMessageListOption  option,
V2NIMSuccessCallback< V2NIMMessageListResult success,
V2NIMFailureCallback  failure 
)

查询历史消息 分页接口,每次默认50条,可以根据参数组合查询各种类型

参数
option查询消息配置选项
success查询成功回调,返回V2NIMMessageListResult,携带下页的消息锚点
failure查询失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getP2PMessageReceipt ( String  conversationId,
V2NIMSuccessCallback< V2NIMP2PMessageReadReceipt success,
V2NIMFailureCallback  failure 
)

查询点对点消息已读回执

参数
conversationId会话ID
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getPinnedMessageList ( String  conversationId,
V2NIMSuccessCallback< List< V2NIMMessagePin >>  success,
V2NIMFailureCallback  failure 
)

获取 pin 消息列表

参数
conversationId 会话 ID
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getQuickCommentList ( List< V2NIMMessage messages,
V2NIMSuccessCallback< Map< String, List< V2NIMMessageQuickComment >>>  success,
V2NIMFailureCallback  failure 
)

获取快捷评论列表

参数
messages需要查询快捷评论的消息列表 如果list为空, 或者size为0, 返回参数错误
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getTeamMessageReceiptDetail ( V2NIMMessage  message,
Set< String >  memberAccountIds,
V2NIMSuccessCallback< V2NIMTeamMessageReadReceiptDetail success,
V2NIMFailureCallback  failure 
)

获取群消息已读回执状态详情

参数
message需要查询已读回执状态的消息
memberAccountIds查找指定的账号列表已读未读 为空表示查询全部 同时作用于已读未读账号列表和人数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getTeamMessageReceipts ( List< V2NIMMessage messages,
V2NIMSuccessCallback< List< V2NIMTeamMessageReadReceipt >>  success,
V2NIMFailureCallback  failure 
)

获取群消息已读回执状态 所有消息必须属于同一个会话,否则返回 191001 使用姿势错误 单次消息数量上限50 只返回存在且有效的消息的已读回执

参数
messages需要查询已读回执状态的消息
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.getThreadMessageList ( V2NIMThreadMessageListOption  threadMessageListOption,
V2NIMSuccessCallback< V2NIMThreadMessageListResult success,
V2NIMFailureCallback  failure 
)

查询thread聊天云端消息列表

参数
threadMessageListOptionthread消息查询选项
success查询成功回调
failure查询失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.importMessagesToLocal ( List< V2NIMMessage messages,
V2NIMImportMessagesToLocalOption  option,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

批量导入本地消息

参数
messages需要导入的消息列表
option导入选项
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.insertMessageToLocal ( V2NIMMessage  message,
String  conversationId,
String  senderId,
long  createTime,
V2NIMSuccessCallback< V2NIMMessage success,
V2NIMFailureCallback  failure 
)

插入一条本地消息, 该消息不会发送 该消息不会多端同步,只是本端显示 插入成功后, SDK会抛出回调 Web端不支持该接口

参数
message需要插入的消息体
conversationId会话 ID
senderId消息发送者账号
createTime指定插入消息时间
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.insertMessageToLocalEx ( V2NIMMessage  message,
V2NIMMessageInsertParams  params,
V2NIMSuccessCallback< V2NIMMessage success,
V2NIMFailureCallback  failure 
)

插入一条本地消息(扩展版),该消息不会发送

不做消息类型限制

插入后表现:

  • 如果本地没有会话,则需要生成会话,消息删除后,会话不联动删除
  • 如果本地已经有会话,需要变更会话的最后一条消息
  • 是最后一条消息且删除,需要变更会话的最后一条消息,往前回溯上一条消息

若消息客户端ID为空,则生成UUID

以自己名义插入消息不变更未读,以对方名义的插入的消息根据消息是否计入未读字段来确认-主要影响本地会话

是否更新会话,以消息配置字段为准,如果不计入未读且不更会话且当前会话不存在,则默认不出现会话入口-主要影响本地会话

该消息不会多端同步,只是本端显示

插入消息默认成功,消息后续可以更新

插入方式:

  • 点对点:可以以自己的名义发送一条给对方的消息,也可以以对方的名义发送一条给自己
  • 群:以任意群成员名义插入一条消息

应用卸载后,该消息丢失,不能恢复

参数
message需要插入的消息体
params插入消息相关参数,包括会话ID、发送者账号、创建时间、是否更新会话最后一条消息等
success插入消息成功回调
failure插入消息失败回调
boolean com.netease.nimlib.sdk.v2.message.V2NIMMessageService.isPeerRead ( V2NIMMessage  message)

查询点对点消息是否对方已读 内部判断逻辑为: 消息时间小于对方已读回执时间都为true

参数
message需要查询的消息
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.modifyMessage ( V2NIMMessage  message,
V2NIMModifyMessageParams  params,
V2NIMSuccessCallback< V2NIMModifyMessageResult success,
V2NIMFailureCallback  failure 
)

更新消息

参数
message需要更新的消息
params更新参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.pinMessage ( V2NIMMessage  message,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

Pin一条消息 Pin成功后,SDK会抛出回调

参数
message需要被pin的消息体
serverExtension扩展字段
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.regenAIMessage ( V2NIMMessage  message,
V2NIMMessageAIRegenParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

重新输出数字人消息

参数
message需要重新输出的消息体
params重新输出的配置参数,确定重新输出的操作类型
success重新输出成功回调
failure重新输出失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.registerCustomAttachmentParser ( V2NIMMessageCustomAttachmentParser  parser)

注册自定义消息附件解析器,解析自定义消息类型为100的附件 后注册的解析器优先于先注册的解析器

参数
parser自定义消息附件解析器
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.removeCollections ( List< V2NIMCollection collections,
V2NIMSuccessCallback< Integer >  success,
V2NIMFailureCallback  failure 
)

添加一个收藏 可以收藏消息, 也可以收藏其他自定义内容 后续可能会移动到另外单独服务中, 它与消息不绑定

参数
collections需要移除的相关收藏
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.removeMessageListener ( V2NIMMessageListener  listener)

移除消息监听

参数
listener消息监听回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.removeQuickComment ( V2NIMMessageRefer  messageRefer,
long  index,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

移除快捷评论

参数
messageRefer要移除快捷评论的消息引用
index快捷评论索引
serverExtension扩展字段, 最大8个字符
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.replyMessage ( V2NIMMessage  message,
V2NIMMessage  replyMessage,
V2NIMSendMessageParams  params,
V2NIMSuccessCallback< V2NIMSendMessageResult success,
V2NIMFailureCallback  failure,
V2NIMProgressCallback  progress 
)

回复消息

参数
message需要发送的消息体
replyMessage被回复的消息
params发送消息相关配置参数,可以配置如下参数,具体参见参数定义 消息相关参数配置 消息推送参数配置 消息反垃圾配置 抄送信息配置
success发送消息成功回调
failure发送消息失败回调
progress发送消息进度回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.revokeMessage ( V2NIMMessage  message,
V2NIMMessageRevokeParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

撤回单条消息 如果被删除消息未发送成功, 则只删除本地消息 删除本地消息不会多端同步,删除云端会多端同步

参数
message需要撤回的消息
params撤回消息相关参数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.searchCloudMessages ( V2NIMMessageSearchParams  params,
V2NIMSuccessCallback< List< V2NIMMessage >>  success,
V2NIMFailureCallback  failure 
)

搜索云端消息

参数
params消息检索参数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.searchCloudMessagesEx ( V2NIMMessageSearchExParams  params,
V2NIMSuccessCallback< V2NIMMessageSearchResult success,
V2NIMFailureCallback  failure 
)

搜索云端消息

参数
params消息检索参数
success消息检索成功回调
failure消息检索失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.searchLocalMessages ( V2NIMMessageSearchExParams  params,
V2NIMSuccessCallback< V2NIMMessageSearchResult success,
V2NIMFailureCallback  failure 
)

检索本地消息

参数
params消息检索参数
success消息检索成功回调
failure消息检索失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.sendMessage ( V2NIMMessage  message,
String  conversationId,
V2NIMSendMessageParams  params,
V2NIMSuccessCallback< V2NIMSendMessageResult success,
V2NIMFailureCallback  failure,
V2NIMProgressCallback  progress 
)

发送消息接口 主要运用于文件类消息,回调文件发送进度

参数
message需要发送的消息体
conversationId会话 ID
params发送消息相关配置参数,可以配置如下参数,具体参见参数定义 消息相关参数配置 消息推送参数配置 消息反垃圾配置 抄送信息配置
success发送消息成功回调
failure发送消息失败回调
progress发送消息进度回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.sendP2PMessageReceipt ( V2NIMMessage  message,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

发送消息已读回执

参数
message点对点会话最近一条消息
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.sendTeamMessageReceipts ( List< V2NIMMessage messages,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

发送消息已读回执 所有消息必须属于同一个会话,否则返回 191001 使用姿势错误

参数
messages需要发送已读回执的消息列表
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.setMessageFilter ( V2NIMMessageFilter  filter)

安装消息过滤器

云端会话的最后一条消息不受该过滤器控制

参数
filter消息过滤器,传null 则取消消息过滤
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.stopAIStreamMessage ( V2NIMMessage  message,
V2NIMMessageAIStreamStopParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

停止流式消息输出

参数
message需要停止的消息体
params停止AI流式消息相关参数
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.translateText ( V2NIMTextTranslateParams  params,
V2NIMSuccessCallback< V2NIMTextTranslationResult success,
V2NIMFailureCallback  failure 
)

文本翻译接口,支持将原始文本翻译为指定语言 使用时需要控制台开通文本翻译功能

参数
params文本翻译相关选项参数
success成功回调
failure失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.unpinMessage ( V2NIMMessageRefer  messageRefer,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

取消一条Pin消息

参数
messageRefer需要被unpin的消息引用
serverExtension扩展字段
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.unregisterCustomAttachmentParser ( V2NIMMessageCustomAttachmentParser  parser)

取消注册自定义消息附件解析器

参数
parser自定义消息附件解析器
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.updateCollectionExtension ( V2NIMCollection  collection,
String  serverExtension,
V2NIMSuccessCallback< V2NIMCollection success,
V2NIMFailureCallback  failure 
)

更新收藏扩展字段

参数
collection需要更新的收藏信息
serverExtension为空, 表示移除扩展字段 否则更新为新扩展字段
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.updateLocalMessage ( V2NIMMessage  message,
V2NIMUpdateLocalMessageParams  params,
V2NIMSuccessCallback< V2NIMMessage success,
V2NIMFailureCallback  failure 
)

更新本地插入的消息 serverid为0的消息 云端消息请调用modifyMessage接口

参数
message需要被更新的消息体
params需要更新的数据字段
success更新成功回调
failure更新失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.updateMessageLocalExtension ( V2NIMMessage  message,
String  localExtension,
V2NIMSuccessCallback< V2NIMMessage success,
V2NIMFailureCallback  failure 
)

更新消息本地扩展字段

参数
message需要被更新的消息体
localExtension扩展字段
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.updatePinMessage ( V2NIMMessage  message,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

更新一条 Pin 消息

参数
message需要被更新pin的消息体
serverExtension扩展字段
success发送消息成功回调
failure发送消息失败回调
void com.netease.nimlib.sdk.v2.message.V2NIMMessageService.voiceToText ( V2NIMVoiceToTextParams  params,
V2NIMSuccessCallback< String >  success,
V2NIMFailureCallback  failure 
)

语音转文字

参数
params本地语音文件
success发送消息成功回调
failure发送消息失败回调

该接口的文档由以下文件生成: