消息相关接口

更新时间: 2024/08/12 15:52:43

消息相关接口提供消息操作的功能。

ChatRepo

ChatRepo 类提供聊天相关数据能力层。

方法列表

接口
接口原型 接口描述
addCollection addCollection(param: V2NIMAddCollectionParams, callback: FetchCallback?) 收藏消息,添加收藏。
addMessageListener addMessageListener(listener: ChatListener) 添加消息监听器。
addNotificationListener addNotificationListener(listener: V2NIMNotificationListener) 添加系统通知回调。
clearChattingId clearChattingId() 清除设置的当前聊天账号信息。
clearHistoryMessage clearHistoryMessage(option: V2NIMClearHistoryMessageOption, callback: FetchCallback<Void?>?) 清理历史消息。
deleteMessage deleteMessage(message: V2NIMMessage, serverExtension: String?, onlyDeleteLocal: Boolean, callback: FetchCallback<Void>?) 删除消息。
deleteMessages deleteMessages(messages: List, serverExtension: String?, onlyDeleteLocal: Boolean, callback: FetchCallback<Void>?) 批量删除消息,最多 50 条。
downloadAttachment downloadAttachment(msg: V2NIMMessage, path: String, callback: ProgressFetchCallback<String>?) 下载消息附件。
downloadMultiMsg downloadMultiMsg(url: String, path: String, callback: FetchCallback<List<IMMessageInfo>>?) 下载合并转发消息。
getCollectionList getCollectionList(type: Int, callback: FetchCallback<List>?) 获取收藏列表。
getCollections getCollections(option: V2NIMCollectionOption, callback: FetchCallback<List>?) 查询收藏消息。
getConversationId getConversationId(): String? 获取当前聊天的会话 ID,返回的是 ConversationId
getMessageList getMessageList(option: V2NIMMessageListOption, enableReceipts: Boolean = true, enablePin: Boolean = true, callback: FetchCallback<List<IMMessageInfo>>?) 获取历史消息。
getMessageListByRefers getMessageListByRefers(messageRefers: List, callback: FetchCallback<List<IMMessageInfo>>) 查询消息,返回包括用户信息的数据。
getP2PMessageReceipt getP2PMessageReceipt(conversationId: String?, callback: FetchCallback<V2NIMP2PMessageReadReceipt?>?) 获取单聊中消息的已读未读状态。
getPinnedMessageList getPinnedMessageList(conversationId: String, callback: FetchCallback<List<IMMessageInfo>>) 查询 pin 消息。
getTeamMessageReceiptDetail getTeamMessageReceiptDetail(message: V2NIMMessage, memberAccountIds: Set<String>?, callback: FetchCallback<IMTeamMsgAckInfo>?) 群消息发送方查询单条群组消息已读、未读账号列表。
getTeamMessageReceipts getTeamMessageReceipts(messages: List) 群消息发送方批量刷新群组消息已读、未读的数量信息。刷新后,会回调 onReceiveTeamMessageReadReceipts()
insertMessageToLocal insertMessageToLocal(message: V2NIMMessage?, conversationId: String, senderId: String, createTime: Long, callback: FetchCallback<V2NIMMessage?>?) 保存消息到本地。
markP2PMessageRead markP2PMessageRead(message: V2NIMMessage, callback: FetchCallback<Void?>?) 设置单聊中消息为已读状态。
markTeamMessagesRead markTeamMessagesRead(messages: List, callback: FetchCallback<Void?>?) 设置群组消息为已读状态。
pinMessage pinMessage(message: V2NIMMessage, serverExtension: String? = null, callback: FetchCallback<Void?>?) pin 一条消息。
removeCollection removeCollection(collection: V2NIMCollection, callback: FetchCallback<Void?>?) 删除收藏。
removeCollections removeCollections(collections: List, callback: FetchCallback<Void?>?) 取消收藏消息。
removeMessageListener removeMessageListener(listener: ChatListener) 移除消息监听器。
removeNotificationListener removeNotificationListener(listener: V2NIMNotificationListener) 移除系统通知回调。
revokeMessage revokeMessage(message: V2NIMMessage, params: V2NIMMessageRevokeParams?, callback: FetchCallback<Void>) 撤回消息。
searchMessages searchMessages(params: V2NIMMessageSearchParams, callback: FetchCallback<List<IMMessageInfo>>) 根据关键字搜索消息。
sendCustomNotification sendCustomNotification(conversationId: String, content: String, params: V2NIMSendCustomNotificationParams?, callback: FetchCallback<Void>?) 发送自定义通知。
sendMessage sendMessage(message: V2NIMMessage, conversationId: String, params: V2NIMSendMessageParams?, callback: ProgressFetchCallback?) 发送消息。
setChattingId setChattingId(conversationId: String, sessionType: V2NIMConversationType) 设置当前聊天的账号。
unpinMessage unpinMessage(message: V2NIMMessageRefer, serverExtension: String? = null, callback: FetchCallback<Void?>?) 移除 pin 消息。
此文档是否对你有帮助?
有帮助
去反馈
  • ChatRepo 类
  • 方法列表