V2NIMMessageService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message;
 
import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMProgressCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageQuickCommentPushConfig;
import com.netease.nimlib.sdk.v2.message.option.V2NIMClearHistoryMessageOption;
import com.netease.nimlib.sdk.v2.message.option.V2NIMCollectionOption;
import com.netease.nimlib.sdk.v2.message.option.V2NIMMessageListOption;
import com.netease.nimlib.sdk.v2.message.option.V2NIMThreadMessageListOption;
import com.netease.nimlib.sdk.v2.message.params.V2NIMAddCollectionParams;
import com.netease.nimlib.sdk.v2.message.params.V2NIMMessageRevokeParams;
import com.netease.nimlib.sdk.v2.message.params.V2NIMMessageSearchParams;
import com.netease.nimlib.sdk.v2.message.params.V2NIMModifyMessageParams;
import com.netease.nimlib.sdk.v2.message.params.V2NIMSendMessageParams;
import com.netease.nimlib.sdk.v2.message.params.V2NIMVoiceToTextParams;
import com.netease.nimlib.sdk.v2.message.result.V2NIMModifyMessageResult;
import com.netease.nimlib.sdk.v2.message.result.V2NIMSendMessageResult;
import com.netease.nimlib.sdk.v2.message.result.V2NIMThreadMessageListResult;
import java.util.List;
import java.util.Map;
import java.util.Set;
 
public interface V2NIMMessageService {
 
    /**
     * 发送消息接口
     * 主要运用于文件类消息，回调文件发送进度
     *
     * @param message 需要发送的消息体
     * @param conversationId 会话 ID
     * @param params 发送消息相关配置参数，可以配置如下参数，具体参见参数定义
     *              消息相关参数配置
     *              消息推送参数配置
     *              消息反垃圾配置
     *              抄送信息配置
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     * @param progress 发送消息进度回调
     */
    void sendMessage(V2NIMMessage message,
                     String conversationId,
                     V2NIMSendMessageParams params,
                     V2NIMSuccessCallback<V2NIMSendMessageResult> success,
                     V2NIMFailureCallback failure,
                     V2NIMProgressCallback progress);
 
    /**
     * 回复消息
     *
     * @param message 需要发送的消息体
     * @param replyMessage 被回复的消息
     * @param params 发送消息相关配置参数，可以配置如下参数，具体参见参数定义
     *              消息相关参数配置
     *              消息推送参数配置
     *              消息反垃圾配置
     *              抄送信息配置
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     * @param progress 发送消息进度回调
     */
    void replyMessage(V2NIMMessage message,
                      V2NIMMessage replyMessage,
                      V2NIMSendMessageParams params,
                      V2NIMSuccessCallback<V2NIMSendMessageResult> success,
                      V2NIMFailureCallback failure,
                      V2NIMProgressCallback progress);
 
    /**
     * 撤回单条消息
     * 如果被删除消息未发送成功， 则只删除本地消息
     * 删除本地消息不会多端同步，删除云端会多端同步
     *
     * @param message 需要撤回的消息
     * @param params 撤回消息相关参数
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void revokeMessage(V2NIMMessage message, V2NIMMessageRevokeParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
 
    /**
     * 查询历史消息
     * 分页接口，每次默认50条，可以根据参数组合查询各种类型
     *
     * @param option 查询消息配置选项
     * @param success 查询成功回调
     * @param failure 查询失败回调
     */
    void getMessageList(V2NIMMessageListOption option, V2NIMSuccessCallback<List<V2NIMMessage>> success, V2NIMFailureCallback failure);
 
 
    /**
     * 根据ID列表查询消息
     * 只查询本地数据库
     *
     * @param messageClientIds 需要查询的消息客户端ID列表
     *  若为空，或者数量为0，返回参数错误
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void getMessageListByIds(List<String> messageClientIds, V2NIMSuccessCallback<List<V2NIMMessage>> success, V2NIMFailureCallback failure);
 
 
    /**
     * 根据MessageRefer列表查询消息
     * 先查询本地数据库， 不存在查询已有协议（23-2）
     *  如果本地数据已经存在， 则直接返回成功
     *  如果本地数据不存在或者不全， 则服务器查询缺失数据
     *      如果服务器协议层失败， 则直接返回失败
     *      如果服务器内容部分失败， 则返回成功列表数据
     *
     * @param messageRefers 需要查询的消息Refer列表
     *  若为空，或者数量为0，返回参数错误
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void getMessageListByRefers(List<V2NIMMessageRefer> messageRefers, V2NIMSuccessCallback<List<V2NIMMessage>> success, V2NIMFailureCallback failure);
 
 
    /**
     * 删除单条消息
     * 如果被删除消息未发送成功， 则只删除本地消息
     * 删除本地消息不会多端同步，删除云端会多端同步
     *
     * @param message 需要删除的消息
     * @param serverExtension 扩展字段, 会多端同步到其他的登录端
     * @param onlyDeleteLocal 是否只删除本地消息
     *      true：只删除本地，本地会将该消息标记为删除， getMessageList会过滤该消息，界面不展示，卸载重装会再次显示
     *      false：同时删除云端， 删除后消息不能恢复
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void deleteMessage(V2NIMMessage message, String serverExtension, boolean onlyDeleteLocal, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 批量删除消息
     * 如果被删除消息未发送成功， 则只删除本地消息
     * 所有消息必须属于同一个会话
     * 每次最多50条消息，超过50条返回参数错误
     * 删除本地消息不会多端同步，删除云端会多端同步
     * 不考虑部分删除失败的情况
     *
     * @param messages 需要删除的消息列表
     * @param serverExtension 扩展字段, 会多端同步到其他的登录端
     * @param onlyDeleteLocal 是否只删除本地消息
     *      true：只删除本地，本地会将该消息标记为删除， getMessageList会过滤该消息，界面不展示，卸载重装会再次显示
     *      false：同时删除云端， 删除后消息不能恢复
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void deleteMessages(List<V2NIMMessage> messages, String serverExtension, boolean onlyDeleteLocal, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 清空历史消息
     * 同步删除本地消息，云端消息
     * 会话不会被删除， 如果需要删除会话，请调用删除会话接口
     *
     * @param option 清空消息参数，清空参数不能为空 必填
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void clearHistoryMessage(V2NIMClearHistoryMessageOption option, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 更新消息本地扩展字段
     *
     * @param message 需要被更新的消息体
     * @param localExtension 扩展字段
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void updateMessageLocalExtension(V2NIMMessage message, String localExtension, V2NIMSuccessCallback<V2NIMMessage> success, V2NIMFailureCallback failure);
 
    /**
     * 插入一条本地消息， 该消息不会发送
     * 该消息不会多端同步，只是本端显示
     * 插入成功后， SDK会抛出回调
     * Web端不支持该接口
     *
     * @param message 需要插入的消息体
     * @param conversationId 会话 ID
     * @param senderId 消息发送者账号
     * @param createTime 指定插入消息时间
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void insertMessageToLocal(V2NIMMessage message, String conversationId, String senderId, long createTime, V2NIMSuccessCallback<V2NIMMessage> success, V2NIMFailureCallback failure);
 
    /**
     * Pin一条消息
     * Pin成功后，SDK会抛出回调
     *
     * @param message 需要被pin的消息体
     * @param serverExtension 扩展字段
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void pinMessage(V2NIMMessage message, String serverExtension, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 取消一条Pin消息
     *
     * @param messageRefer 需要被unpin的消息引用
     * @param serverExtension 扩展字段
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void unpinMessage(V2NIMMessageRefer messageRefer, String serverExtension, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 更新一条 Pin 消息
     *
     * @param message 需要被更新pin的消息体
     * @param serverExtension 扩展字段
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void updatePinMessage(V2NIMMessage message, String serverExtension, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 获取 pin 消息列表
     *
     * @param conversationId   会话 ID
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void getPinnedMessageList(String conversationId, V2NIMSuccessCallback<List<V2NIMMessagePin>> success, V2NIMFailureCallback failure);
 
    /**
     * 添加快捷评论
     *
     * @param message 被快捷评论的消息
     * @param index 快捷评论索引，可以自定义映射关系，例如
     *      表情回复： 可以本地构造映射关系， 1：笑脸  2：大笑， 当前读取到对应的index后，界面展示可以替换对应的表情
     *      还可以应用于其他场景， 文本快捷回复等
     *      大于 0
     * @param serverExtension 扩展字段， 最大8个字符
     * @param pushConfig 快捷评论推送配置
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void addQuickComment(V2NIMMessage message, long index, String serverExtension, V2NIMMessageQuickCommentPushConfig pushConfig, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 移除快捷评论
     *
     * @param messageRefer 要移除快捷评论的消息引用
     * @param index 快捷评论索引
     * @param serverExtension 扩展字段， 最大8个字符
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void removeQuickComment(V2NIMMessageRefer messageRefer, long index, String serverExtension, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 获取快捷评论列表
     *
     * @param messages 需要查询快捷评论的消息列表
     *      如果list为空， 或者size为0， 返回参数错误
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void getQuickCommentList(List<V2NIMMessage> messages, V2NIMSuccessCallback<Map<String, List<V2NIMMessageQuickComment>>> success, V2NIMFailureCallback failure);
 
    /**
     * 添加一个收藏
     * 可以收藏消息， 也可以收藏其他自定义内容
     * 后续可能会移动到另外单独服务中， 它与消息不绑定
     *
     * @param params 添加收藏相关参数
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void addCollection(V2NIMAddCollectionParams params, V2NIMSuccessCallback<V2NIMCollection> success, V2NIMFailureCallback failure);
 
 
    /**
     * 添加一个收藏
     * 可以收藏消息， 也可以收藏其他自定义内容
     * 后续可能会移动到另外单独服务中， 它与消息不绑定
     *
     * @param collections 需要移除的相关收藏
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void removeCollections(List<V2NIMCollection> collections, V2NIMSuccessCallback<Integer> success, V2NIMFailureCallback failure);
 
 
    /**
     * 更新收藏扩展字段
     *
     * @param collection 需要更新的收藏信息
     * @param serverExtension
     *      为空， 表示移除扩展字段
     *      否则更新为新扩展字段
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void updateCollectionExtension (V2NIMCollection collection, String serverExtension, V2NIMSuccessCallback<V2NIMCollection> success, V2NIMFailureCallback failure);
 
 
    /**
     * 按条件分页获取收藏信息
     *
     * @param option 查询参数
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void getCollectionListByOption (V2NIMCollectionOption option, V2NIMSuccessCallback<List<V2NIMCollection>> success, V2NIMFailureCallback failure);
 
 
    /**
     * 发送消息已读回执
     *
     * @param message 点对点会话最近一条消息
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void sendP2PMessageReceipt(V2NIMMessage message, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
 
    /**
     * 查询点对点消息已读回执
     *
     * @param conversationId 会话ID
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void getP2PMessageReceipt(String conversationId, V2NIMSuccessCallback<V2NIMP2PMessageReadReceipt> success, V2NIMFailureCallback failure);
 
 
    /**
     * 查询点对点消息是否对方已读
     * 内部判断逻辑为： 消息时间小于对方已读回执时间都为true
     *
     * @param message 需要查询的消息
     */
    boolean isPeerRead(V2NIMMessage message);
 
 
    /**
     * 发送消息已读回执
     * 所有消息必须属于同一个会话，否则返回 191001 使用姿势错误
     *
     * @param messages 需要发送已读回执的消息列表
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void sendTeamMessageReceipts(List<V2NIMMessage> messages, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
 
    /**
     * 获取群消息已读回执状态
     * 所有消息必须属于同一个会话，否则返回 191001 使用姿势错误
     * 单次消息数量上限50
     * 只返回存在且有效的消息的已读回执
     *
     * @param messages 需要查询已读回执状态的消息
     * @param success  发送消息成功回调
     * @param failure  发送消息失败回调
     */
    void getTeamMessageReceipts(List<V2NIMMessage> messages, V2NIMSuccessCallback<List<V2NIMTeamMessageReadReceipt>> success, V2NIMFailureCallback failure);
 
 
    /**
     * 获取群消息已读回执状态详情
     *
     * @param message           需要查询已读回执状态的消息
     * @param memberAccountIds  查找指定的账号列表已读未读
     *                              为空表示查询全部
     *                              同时作用于已读未读账号列表和人数
     * @param success           发送消息成功回调
     * @param failure           发送消息失败回调
     */
    void getTeamMessageReceiptDetail(V2NIMMessage message, Set<String> memberAccountIds, V2NIMSuccessCallback<V2NIMTeamMessageReadReceiptDetail> success, V2NIMFailureCallback failure);
 
 
    /**
     * 语音转文字
     *
     * @param params 本地语音文件
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void voiceToText(V2NIMVoiceToTextParams params, V2NIMSuccessCallback<String> success, V2NIMFailureCallback failure);
 
    /**
     * 取消文件类附件上传，只有文件类消息可以调用该接口
     * 如果文件已经上传成功，则取消失败
     * 如果取消成功， 则对应消息文件上传状态会变成V2NIMMessageAttachmentUploadState.V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_FAILED，同时消息会发送失败
     *
     * @param message 需要取消附件上传的消息体
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void cancelMessageAttachmentUpload(V2NIMMessage message, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
 
    /**
     * 搜索云端消息
     *
     * @param params  消息检索参数
     * @param success 发送消息成功回调
     * @param failure 发送消息失败回调
     */
    void searchCloudMessages(V2NIMMessageSearchParams params, V2NIMSuccessCallback<List<V2NIMMessage>> success, V2NIMFailureCallback failure);
 
    /**
     * 查询thread聊天云端消息列表
     * @param threadMessageListOption thread消息查询选项
     * @param success 查询成功回调
     * @param failure 查询失败回调
     */
    void getThreadMessageList(V2NIMThreadMessageListOption threadMessageListOption, V2NIMSuccessCallback<V2NIMThreadMessageListResult> success, V2NIMFailureCallback failure);
 
    /**
     * 查询thread聊天本地消息列表
     * @param messageRefer 根消息引用
     * @param success 查询成功回调
     * @param failure 查询失败回调
     */
    void getLocalThreadMessageList(V2NIMMessageRefer messageRefer, V2NIMSuccessCallback<V2NIMThreadMessageListResult> success, V2NIMFailureCallback failure);
 
    /**
     * 更新消息
     * @param message 需要更新的消息
     * @param params 更新参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void modifyMessage(V2NIMMessage message, V2NIMModifyMessageParams params, V2NIMSuccessCallback<V2NIMModifyMessageResult> success, V2NIMFailureCallback failure);
    /**
     *  添加消息监听
     *
     *  @param listener 消息监听回调
     */
    void addMessageListener(V2NIMMessageListener listener);
 
    /**
     *  移除消息监听
     *
     *  @param listener 消息监听回调
     */
    void removeMessageListener(V2NIMMessageListener listener);
}