MsgService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg;
 
import android.util.Pair;
 
import com.netease.nimlib.NimNosSceneKeyConstant;
import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.notifier.support26.annotation.NonNull;
import com.netease.nimlib.sdk.AbortableFuture;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.NosTokenSceneConfig;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.migration.model.MigrationConstant;
import com.netease.nimlib.sdk.migration.processor.IMsgExportProcessor;
import com.netease.nimlib.sdk.migration.processor.IMsgImportProcessor;
import com.netease.nimlib.sdk.msg.attachment.FileAttachment;
import com.netease.nimlib.sdk.msg.attachment.MsgAttachmentParser;
import com.netease.nimlib.sdk.msg.constant.AttachStatusEnum;
import com.netease.nimlib.sdk.msg.constant.DeleteTypeEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.sdk.msg.model.CollectInfo;
import com.netease.nimlib.sdk.msg.model.CollectInfoPage;
import com.netease.nimlib.sdk.msg.model.CustomNotification;
import com.netease.nimlib.sdk.msg.model.GetMessagesDynamicallyParam;
import com.netease.nimlib.sdk.msg.model.GetMessagesDynamicallyResult;
import com.netease.nimlib.sdk.msg.model.IMMessage;
import com.netease.nimlib.sdk.msg.model.LocalAntiSpamResult;
import com.netease.nimlib.sdk.msg.model.MessageKey;
import com.netease.nimlib.sdk.msg.model.MsgFullKeywordSearchConfig;
import com.netease.nimlib.sdk.msg.model.MsgPinDbOption;
import com.netease.nimlib.sdk.msg.model.MsgPinSyncResponseOptionWrapper;
import com.netease.nimlib.sdk.msg.model.MsgSearchOption;
import com.netease.nimlib.sdk.msg.model.MsgTimingFullKeywordSearchConfig;
import com.netease.nimlib.sdk.msg.model.NIMMessage;
import com.netease.nimlib.sdk.msg.model.QueryDirectionEnum;
import com.netease.nimlib.sdk.msg.model.QueryMySessionOption;
import com.netease.nimlib.sdk.msg.model.QueryThreadTalkHistoryOption;
import com.netease.nimlib.sdk.msg.model.QuickCommentOptionWrapper;
import com.netease.nimlib.sdk.msg.model.RecentContact;
import com.netease.nimlib.sdk.msg.model.RecentSession;
import com.netease.nimlib.sdk.msg.model.RecentSessionList;
import com.netease.nimlib.sdk.msg.model.SessionAckInfo;
import com.netease.nimlib.sdk.msg.model.ShowNotificationWhenRevokeFilter;
import com.netease.nimlib.sdk.msg.model.StickTopSessionInfo;
import com.netease.nimlib.sdk.msg.model.ThreadTalkHistory;
import com.netease.nimlib.sdk.search.model.MsgIndexRecord;
import com.netease.nimlib.sdk.team.model.IMMessageFilter;
 
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
 
/**
 * 云信消息服务接口类，提供消息发送、消息查询、历史消息、消息扩展功能、获取未读数、已读回执、会话列表等相关接口。
 */
@NIMService("消息服务")
public interface MsgService {
 
    /**
     * 当前无聊天对象。
     *
     * 消息列表界面有消息提醒，无状态栏消息通知。
     *
     */
    String MSG_CHATTING_ACCOUNT_ALL = "all";
 
    /**
     * 当前无聊天对象。
     *
     * @see #setChattingAccount(String, com.netease.nimlib.sdk.msg.constant.SessionTypeEnum)
     * 消息列表界面有消息提醒，有状态栏消息通知。
     */
    String MSG_CHATTING_ACCOUNT_NONE = null;
 
    /**
     * 发送消息。
     *
     * 该方法为异步。如需更新发送进度，请调用 {@link MsgServiceObserve#observeMsgStatus}。
     *
     * @par 使用前提：
     * 已调用 MessageBuilder#createXXMessage 创建一条消息。
     *
     * @param msg    待发送的 IMMessage 消息体，由 {@link MessageBuilder} 构造。
     * @param resend true 表示消息发送失败后重发；false 表示消息发送失败后不重发。
     * @return InvocationFuture<Void> 可设置回调函数：消息发送成功后返回通知；消息发送失败后返回具体错误码。
     */
    InvocationFuture<Void> sendMessage(IMMessage msg, boolean resend);
 
    /**
     * 回复消息。
     *
     * 该方法为异步。如需更新发送进度，请调用 {@link MsgServiceObserve#observeMsgStatus}。
     *
     * @par 使用前提：
     * - 已收到一条消息。
     * - 已调用 MessageBuilder#createXXMessage 构建一条消息。
     *
     * @param msg    待发送的 IMMessage 消息体，由 {@link MessageBuilder} 构造。
     * @param replyMsg 被回复的 IMMessage 消息体，由 {@link MessageBuilder} 构造。
     * @param resend true 表示消息回复失败后重发；false 表示消息回复失败后不重发。
     * @return InvocationFuture<Void> 可设置回调函数：消息回复成功后返回通知；消息回复失败后返回具体错误码。
     */
    InvocationFuture<Void> replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend);
 
 
    /**
     * 发送文件。该方法为异步。
     *
     * @par 使用前提：
     * 已调用 {@link MessageBuilder#createFileAttachment} 创建文件附件。
     *
     * @param attachment 待发送的文件附件对象 FileAttachment，由 {@link MessageBuilder} 构造。
     *
     * @return AbortableFuture<FileAttachment> 可设置回调函数：文件发送成功后返回 FileAttachment，可随时中断发送；文件发送失败后返回具体错误码。
     */
    AbortableFuture<FileAttachment> sendFile(FileAttachment attachment);
 
    /**
     * 插入消息到本地数据库，但不发送到服务器端。该方法为异步。
     *
     * 该方法将消息插入到本地数据库后，SDK 会触发 {@link MsgServiceObserve#observeReceiveMessage} 通知到 UI 层。
     *
     * @param msg 待插入的消息体 IMMessage，由 {@link MessageBuilder} 构造。
     * @param fromAccount 消息发送方账号（accid）
     * @return InvocationFuture<Void> 可设置回调函数：消息插入成功后返回通知；消息插入失败后返回具体错误码。
     */
    InvocationFuture<Void> insertLocalMessage(IMMessage msg, String fromAccount);
 
    /**
     * 保存消息到本地数据库，但不发送到服务器端。该方法为异步。<br>
     * 该方法用于第三方应用保存本地提醒类的消息。<br>
     * 将消息保存到数据库后，如需通知 UI 层更新，可将 notify 设置为 true，此时会触发 {@link MsgServiceObserve#observeReceiveMessage} 通知。
     *
     * @param msg 待保存的消息体 IMMessage，由 {@link MessageBuilder} 构造。
     * @param notify 是否需要通知
     * @return InvocationFuture<Void> 可设置回调函数：消息保存成功后返回通知；消息保存失败后返回具体错误码。
     */
    InvocationFuture<Void> saveMessageToLocal(IMMessage msg, boolean notify);
 
    /**
     * 保存消息到本地数据库，但不发送到服务器端。该方法为异步。<br>
     * 该方法用于第三方应用保存本地提醒类的消息。<br>
     * 将消息保存到数据库后，如需通知 UI 层更新，可将 notify 设置为 true，此时会触发 {@link MsgServiceObserve#observeReceiveMessage} 通知。
     *
     * @param msg    待保存的消息体 IMMessage，由 {@link MessageBuilder} 构造。
     * @param notify 是否需要通知
     * @param time   待保存的消息时间戳，您可以使用 {@link NIMMessage#getTime()} 方法获取消息时间戳。
     * @return InvocationFuture<Void> 可设置回调函数：消息保存成功后返回通知；消息保存失败后返回具体错误码。
     */
    InvocationFuture<Void> saveMessageToLocalEx(IMMessage msg, boolean notify, long time);
 
    /**
     * 手动下载附件。
     *
     * @par 使用场景：
     * 自动下载附件失败时，可调用该方法手动下载。
     *
     * @param msg   附件所在的消息体 IMMessage，由 {@link MessageBuilder} 构造。
     * @param thumb 是否仅下载缩略图。true 代表仅下载缩略图；false 代表下载缩略图和原文件。该参数仅对图片和视频类消息有效。
     * @return AbortableFuture<Void> 可设置回调函数，随时中止操作：附件下载成功后返回通知；附件下载失败后返回具体错误码。
     */
    AbortableFuture<Void> downloadAttachment(IMMessage msg, boolean thumb);
 
    /**
     * 通过 uuid 批量获取本地历史消息。该方法为同步。
     *
     * @param uuids 消息的 uuid 列表
     * @return IMMessage 列表
     */
    List<IMMessage> queryMessageListByUuidBlock(List<String> uuids);
 
    /**
     * 通过 uuid 批量获取本地历史消息。该方法为异步。
     *
     * @param uuids 消息的 uuid 列表
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：获取成功后返回消息列表；获取失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryMessageListByUuid(List<String> uuids);
 
    /**
     * 通过 ServerId 批量获取本地历史消息。该方法为同步。
     *
     * @param serverIds 消息的 ServerId 列表，一个 ServerId 可能对应多条消息。
     * @return IMMessage 列表
     */
    List<IMMessage> queryMessageListByServerIdBlock(List<String> serverIds);
 
    /**
     * 根据消息类型从后向前查询本地历史消息。该方法为异步。
     *
     * @param msgTypeEnum 消息类型
     * @param anchor      查询锚点消息，作为查询起始点（不包含锚点），查询方向为从后往前。
     * @param limit       查询结果的条数限制，必须大于 0
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit);
 
    /**
     * 根据消息类型从前向后查询本地历史消息。该方法为异步。
     *
     * @param maxTime     查询起始时间（不包含），查询方向为从前向后，为空则表示查询所有历史消息。
     * @param msgTypeEnum 消息类型
     * @param limit       查询结果的条数限制，必须大于 0。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum, Long maxTime,
                                                             int limit);
 
    /**
     * 根据消息子类型查询本地历史消息。该方法为同步。
     *
     * @param msgTypeEnum   消息类型
     * @param anchor        查询锚点消息，作为查询起始点（不包含锚点）。
     * @param limit         查询结果的条数限制
     * @param subtype       消息子类型
     * @return IMMessage 列表
     */
    List<IMMessage> queryMessageListBySubtypeBlock(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype);
 
    /**
     * 根据消息子类型查询本地历史消息。该方法为异步。
     *
     * @param subtype       消息子类型
     * @param anchor        查询锚点消息，作为查询起始点（不包含锚点）。
     * @param limit         查询结果的条数限制
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryMessageListBySubtype(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype);
 
    /**
     * @deprecated 该方法已废弃，请使用 {@link #queryMessageListEx(IMMessage, QueryDirectionEnum, int, boolean)} 来替代。<br>
     * 查询指定聊天对象的本地历史消息。该方法为异步。<br>
     * 该方法按照消息记录时间先后倒序查询，查询条件为 "ORDER BY time desc limit ${limit} offset ${offset}"。<br>
     *
     * @param account     待查询的聊天对象帐号(个人帐号或群组 ID)
     * @param sessionType 聊天对象类型(单聊或群聊)
     * @param offset      查询偏移量
     * @param limit       查询列表长度限制
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回倒序的消息列表；查询失败后返回具体错误码。
     *
     */
    InvocationFuture<List<IMMessage>> queryMessageList(String account, SessionTypeEnum sessionType, long offset,
                                                       int limit);
 
    /**
     * 根据锚点和方向查询本地历史消息。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点）。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit     查询结果的条数限制
     * @param asc       查询结果的排序规则，true 代表按照时间升序排列，false 代表按照时间降序排列。
 
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryMessageListEx(IMMessage anchor, QueryDirectionEnum direction, int limit,
                                                         boolean asc);
 
    /**
     * 根据锚点和方向查询本地历史消息。该方法为同步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点）。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit     查询结果的条数限制
     * @param asc       查询结果的排序规则，true 代表按照时间升序排列，false 代表按照时间降序排列。
     * @return IMMessage 列表
     */
    List<IMMessage> queryMessageListExBlock(IMMessage anchor, QueryDirectionEnum direction, int limit,
                                            boolean asc);
 
    /**
     * 查询指定时间段的本地历史消息。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点）。
     * @param toTime    查询截止时间点，若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit     查询结果的条数限制
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryMessageListExTime(IMMessage anchor, long toTime,
                                                             QueryDirectionEnum direction, int limit);
 
    /**
     * @deprecated 该方法已废弃，请使用 queryMessageListByTypesV2 来替代。<br>
     * 根据消息类型查询指定时间段的本地历史消息。该方法为异步。<br>
     * @param types     消息类型列表，null 表示所有消息类型，同 {@link MsgService#queryMessageListExTime}
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点）。
     * @param toTime    查询截止时间点，若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit     查询结果的条数限制
     * @param asc       查询结果的排序规则，true 代表按照时间升序排列，false 代表按照时间降序排列。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     *
     */
    @Deprecated
    InvocationFuture<List<IMMessage>> queryMessageListByTypes(List<MsgTypeEnum> types, IMMessage anchor, long toTime,
                                                              QueryDirectionEnum direction, int limit, boolean asc);
 
    /**
     * 根据消息类型查询指定时间段的本地历史消息。该方法为异步。<br>
     * @param types     消息类型列表，null 表示所有消息类型，同 {@link MsgService#queryMessageListExTime}
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点）。单位毫秒，不能为 null。
     * @param toTime    查询截止时间点，若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit     查询结果的条数限制
     * @param asc       查询结果的排序规则，true 代表按照时间升序排列，false 代表按照时间降序排列。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     *
     */
    InvocationFuture<List<IMMessage>> queryMessageListByTypesV2(List<MsgTypeEnum> types, IMMessage anchor, long toTime,
                                                                QueryDirectionEnum direction, int limit, boolean asc);
 
    /**
     * 获取指定会话中有漫游消息标记的时间戳。该方法为异步。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     * @return InvocationFuture<Long> 可设置回调函数：获取成功后返回时间戳，如果无漫游消息标记则返回 0L；获取失败后返回具体错误码。
     */
    InvocationFuture<Long> queryRoamMsgHasMoreTime(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 获取指定会话中有漫游消息标记的消息的时间戳。该方法为同步。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     * @return 如果有漫游消息标记则返回时间戳；如果无漫游消息标记则返回 0L。
     */
    long queryRoamMsgHasMoreTimeBlock(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 获取指定会话中有漫游消息标记的消息的 ServerId。该方法为异步。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     * @return InvocationFuture<Long> 可设置回调函数：获取成功后返回 ServerId，如果无漫游消息标记则返回 0L；获取失败后返回具体错误码。
     */
    InvocationFuture<Long> queryRoamMsgHasMoreTagServerId(String sessionId, SessionTypeEnum sessionType);
 
 
    /**
     * 获取指定会话中有漫游消息标记的消息的 ServerId。该方法为同步。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     * @return 如果有漫游消息标记则返回 ServerId；如果无漫游消息标记则返回 0L。
     */
    long queryRoamMsgHasMoreTagServerIdBlock(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 根据消息关键信息批量查询服务端历史消息。该方法为异步。
     *
     * @param msgKeyList 消息关键信息列表
     * @param persist 查询的漫游消息是否同步到本地数据库。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullHistoryById(List<MessageKey> msgKeyList, boolean persist);
 
    /**
     * 查询同指定用户的最近一条本地历史消息。该方法为同步。
     *
     * @param account     用户账号（accid）
     * @param sessionType 会话类型
     * @return IMMessage 消息体
     */
    IMMessage queryLastMessage(String account, SessionTypeEnum sessionType);
 
    /**
     * 从后向前批量查询服务端历史消息。该方法为异步。<br>
     * @param anchor  查询锚点消息，作为查询起始点（不包含锚点）。不能为 null。<br>
     *                首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param limit   查询的消息条数限制（最大为 100）
     * @param persist 查询的漫游消息是否同步到本地数据库。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistory(IMMessage anchor, int limit, boolean persist);
 
 
    /**
     * 从后向前批量查询服务端历史消息。该方法为异步。<br>
     *
     * @param anchor  查询锚点消息，作为查询起始点（不包含锚点）。不能为 null。<br>
     *                首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param limit   查询的消息条数限制（最大为 100）
     * @param persist 查询的漫游消息是否同步到本地数据库。
     * @param persistClear 清除记录前的消息是否同步到本地数据库。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistory(IMMessage anchor, int limit, boolean persist, boolean persistClear);
 
    /**
     * 查询指定时间段内的服务端历史消息。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。不能设置为 null。<br>
     *                  首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param toTime    查询截止时间点，单位毫秒。若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param limit     查询的消息条数限制（最大为 100）
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param persist   查询的漫游消息是否同步到本地数据库。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryEx(IMMessage anchor, long toTime, int limit,
                                                           QueryDirectionEnum direction, boolean persist);
 
    /**
     * 查询指定时间段和消息类型的的服务端历史消息。该方法为异步。默认不同步到数据库。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。不能设置为 null。<br>
     *                  首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param toTime    查询截止时间点，单位毫秒。若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param limit     查询的消息条数限制（最大为 100）
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param msgTypes  消息类型列表
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes);
 
    /**
     * 查询指定时间段和消息类型的的服务端历史消息，可指定是否同步到数据库。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。不能设置为 null。<br>
     *                  首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param toTime    查询截止时间点，单位毫秒。若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param limit     查询的消息条数限制（最大为 100）
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param msgTypes  消息类型列表
     * @param persist   查询的漫游消息是否同步到本地数据库。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist);
 
    /**
     * 查询指定时间段和消息类型的的服务端历史消息，可指定是否同步到数据库及是否同步被清除的消息到数据库。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。不能设置为 null。<br>
     *                  首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param toTime    查询截止时间点，单位毫秒。若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param limit     查询的消息条数限制（最大为 100）
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param msgTypes  消息类型列表
     * @param persist   查询的漫游消息是否同步到本地数据库。
     * @param persistClear 是否同步被清除的消息到本地数据库。该参数仅在 persist 为 true 时生效。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
                                                               boolean persistClear);
 
    /**
     * 查询指定时间段和消息类型的的服务端历史消息，可指定是否过滤消息通知、是否同步到数据库、是否同步被清除的消息到数据库。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。不能设置为 null。<br>
     *                  首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param toTime    查询截止时间点，单位毫秒。若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param limit     查询的消息条数限制（最大为 100）
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param msgTypes  消息类型列表
     * @param persist   查询的漫游消息是否同步到本地数据库。
     * @param persistClear 是否同步被清除的消息到本地数据库。该参数仅在 persist 为 true 时生效。
     * @param customFilter 过滤器回调，可设置是否过滤消息通知。若返回 true 则过滤消息通知，SDK 将不同步该消息通知至数据库，默认为 false。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
                                                               boolean persistClear, IMMessageFilter customFilter);
 
    /**
     * 查询指定时间段和消息类型的的服务端历史消息，可指定是否计算消息未读数、是否过滤消息通知、是否同步到数据库、是否同步被清除的消息到数据库。该方法为异步。<br>
     *
     * @param anchor    查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。不能设置为 null。<br>
     *                  首次查询可使用 {@link MessageBuilder#createEmptyMessage} 创建一个空消息对象。
     * @param toTime    查询截止时间点，单位毫秒。若查询方向为 QUERY_OLD，toTime 应小于 anchor.getTime；若方向为 QUERY_NEW，toTime 应大于 anchor.getTime。
     * @param limit     查询的消息条数限制（最大为 100）
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param msgTypes  消息类型列表
     * @param persist   查询的漫游消息是否同步到本地数据库。
     * @param persistClear 是否同步被清除的消息到本地数据库。该参数仅在 persist 为 true 时生效。
     * @param customFilter 过滤器回调，可设置是否过滤消息通知。若返回 true 则过滤消息通知，SDK 将不同步该消息通知至数据库，默认为 false。
     * @param updateUnread 是否计算消息未读数
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：查询成功后返回消息列表；查询失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
                                                               boolean persistClear, IMMessageFilter customFilter, boolean updateUnread);
 
    /**
     * 云端（服务端）历史消息全文检索。该方法为异步。<br>
     *
     * @par 使用前提：
     * 已在云信控制台[开启全文云端消息检索功能](https://doc.yunxin.163.com/messaging/docs/TI3NTU1NDA?platform=android)。
     *
     * @param config 全文检索配置
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回按照会话分组的消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistory(MsgFullKeywordSearchConfig config);
 
    /**
     * 云端（服务端）历史消息全文检索，按照消息时间顺序进行排序。该方法为异步。<br>
     *
     * @par 使用前提：
     * 已在云信控制台[开启全文云端消息检索功能](https://doc.yunxin.163.com/messaging/docs/TI3NTU1NDA?platform=android)。
     *
     * @param config 按时间顺序的全文检索配置
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回按时间顺序排序的消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> pullMessageHistoryOrderByTime(
            MsgTimingFullKeywordSearchConfig config);
 
    /**
     * 动态查询本地历史消息。该方法为异步。<br>
     * 该方法调用在数据同步完成后生效。该方法为完整独立的历史消息查询接口，与其他历史消息查询接口互不影响。
     *
     * @par 使用前提：
     * 已在云信控制台[开启动态查询历史消息功能](https://doc.yunxin.163.com/messaging/docs/TI3NTU1NDA?platform=android#开启动态查询历史消息功能d)。
     *
     * @param param 动态查询历史消息配置
     * @return InvocationFuture<GetMessagesDynamicallyResult> 可设置回调函数：成功后返回 GetMessagesDynamicallyResult 回调；失败后返回具体错误码。
     */
    InvocationFuture<GetMessagesDynamicallyResult> getMessagesDynamically(GetMessagesDynamicallyParam param);
 
    /**
     * @deprecated 该方法已废弃，请使用 searchMessage 来替代。
     *
     * 从本地消息数据库搜索消息历史。查询范围由anchor的sessionId和sessionType决定。<br>
     * 以锚点anchor作为起始点开始查询，返回最多limit条匹配key的记录。<br>
     * 该接口目前仅搜索文本类型的消息，匹配规则为文本内容包含keyword，仅支持精确匹配，不支持模糊匹配和拼音匹配。<br>
     * 由于sdk并不存储用户数据，因此keyword不会匹配用户资料。如果调用者希望查询指定用户的说话记录，可提供fromAccounts参数。<br>
     * 如果提供的fromAccounts参数不为空，那么anchor对应的会话（sessionId和sessionType）的消息记录中，
     * 凡是消息说话者在fromAccounts列表中的记录，也会被当做匹配结果，加入搜索结果中。
     * 注意：搜索结果不包含anchor
     *
     * @param keyword      文本消息的搜索关键字
     * @param fromAccounts 消息说话者帐号列表，如果消息说话在该列表中，那么无需匹配keyword，对应的消息记录会直接加入搜索结果集中。
     * @param anchor       搜索的消息锚点
     * @param limit        搜索结果的条数限制
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> searchMessageHistory(String keyword, List<String> fromAccounts, IMMessage anchor,
                                                           int limit);
 
 
    /**
     * @deprecated 该方法已废弃，请使用 searchMessage 来替代。
     *
     * 从本地消息数据库搜索消息历史。查询范围由anchor的sessionId和sessionType决定。<br>
     * 该接口查询方向为从后往前。以锚点anchor作为起始点开始查询，返回最多limit条匹配key的记录。<br>
     * 该接口目前仅搜索文本类型的消息，匹配规则为文本内容包含keyword，仅支持精确匹配，不支持模糊匹配和拼音匹配。<br>
     * 由于sdk并不存储用户数据，因此keyword不会匹配用户资料。如果调用者希望查询指定用户的说话记录，可提供fromAccounts参数。<br>
     * 如果提供的fromAccounts参数不为空，那么anchor对应的会话（sessionId和sessionType）的消息记录中，
     * 凡是消息说话者在fromAccounts列表中的记录，也会被当做匹配结果，加入搜索结果中。
     * 注意：搜索结果不包含anchor
     *
     * @param keyword      文本消息的搜索关键字
     * @param fromAccounts 消息说话者帐号列表，如果消息说话在该列表中，那么无需匹配keyword，对应的消息记录会直接加入搜索结果集中。
     * @param anchor       搜索的消息锚点
     * @param direction    查询方向
     * @param limit        搜索结果的条数限制
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> searchMessageHistory(String keyword, List<String> fromAccounts,
                                                           IMMessage anchor, QueryDirectionEnum direction, int limit);
 
    /**
     * @deprecated 该方法已废弃，请使用 searchAllMessage 来替代。
     *
     * 从本地消息数据库搜索消息历史。
     * 该接口查询方向以某个时间点为基准从后往前，返回最多limit条匹配key的记录。<br>
     * 该接口目前仅搜索文本类型的消息，匹配规则为文本内容包含keyword，仅支持精确匹配，不支持模糊匹配和拼音匹配。<br>
     * 由于sdk并不存储用户数据，因此keyword不会匹配用户资料。如果调用者希望查询指定用户的说话记录，可提供fromAccounts参数。<br>
     * 如果提供的fromAccounts参数不为空，那么凡是消息说话者在fromAccounts列表中的记录，也会被当做匹配结果，加入搜索结果中。
     *
     * @param keyword      文本消息的搜索关键字
     * @param fromAccounts 消息说话者帐号列表，如果消息说话在该列表中，那么无需匹配keyword，对应的消息记录会直接加入搜索结果集中。
     * @param time         查询范围时间点，比time小（从后往前查）
     * @param limit        搜索结果的条数限制
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> searchAllMessageHistory(String keyword, List<String> fromAccounts, long time,
                                                              int limit);
 
    /**
     * 查询指定会话的本地历史消息。该方法为异步。
     *
     * @param sessionType 会话类型
     * @param sessionId 会话 ID。如果是单聊，则为聊天对象 ID；如果是群聊，则为群组 ID。
     * @param option 查询选项，可指定时间段、查询顺序、查询数量限制等。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> searchMessage(SessionTypeEnum sessionType, String sessionId, MsgSearchOption option);
 
    /**
     * 查询所有本地历史消息。该方法为异步。
     *
     * @param option 查询选项，可指定时间段、消息类型、查询数量限制等。
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> searchAllMessage(MsgSearchOption option);
 
 
 
 
    /**
     * 指定关键字检索所有会话。该方法为异步。
     *
     * @param query 检索的关键字
     * @param limit 本次调用返回的数量上限
     * @return InvocationFuture<List<MsgIndexRecord>> 可设置回调函数：成功后返回消息索引记录列表；失败后返回具体错误码。
     */
    InvocationFuture<List<MsgIndexRecord>> searchAllSession(String query, int limit);
 
    /**
     * 指定关键字检索所有会话。该方法为同步。
     *
     * @param query 检索的关键字
     * @param limit 本次调用返回的数量上限
     * @return List<MsgIndexRecord> 消息索引记录列表
     */
    List<MsgIndexRecord> searchAllSessionBlock(String query, int limit);
 
    /**
     * 指定关键字检索指定的会话。该方法为异步。
     *
     * @param query       检索的关键字
     * @param sessionType 会话类型
     * @param sessionId   会话 ID
     * @return InvocationFuture<List<MsgIndexRecord>> 可设置回调函数：成功后返回消息索引记录列表；失败后返回具体错误码。
     */
    InvocationFuture<List<MsgIndexRecord>> searchSession(String query, SessionTypeEnum sessionType, String sessionId);
 
    /**
     * 指定关键字检索指定的会话。该方法为同步。
     *
     * @param query       检索的关键字
     * @param sessionType 会话类型
     * @param sessionId   会话 ID
     * @return List<MsgIndexRecord> 消息索引记录列表
     */
    List<MsgIndexRecord> searchSessionBlock(String query, SessionTypeEnum sessionType, String sessionId);
 
    /**
     * 删除一条本地历史消息，并同步数据库。<br>
     * 从服务端拉取消息时，若存在该消息的本地删除记录，则该消息不会同步到数据库中。
     *
     * @param message 待删除的 IMMessage 消息体
     */
    void deleteChattingHistory(IMMessage message);
 
    /**
     * 删除一条本地历史消息，并指定是否记录删除操作。<br>
     *
     * @param message 待删除的 IMMessage 消息体
     * @param ignore 是否记录删除操作。从服务端拉取消息时，若存在该消息的本地删除记录（ignore 为 true），则该消息不会同步到数据库中。
     */
    void deleteChattingHistory(IMMessage message, boolean ignore);
 
    /**
     * 删除一条本地历史消息，并指定是否记录删除操作。<br>
     *
     * @param msgList 待删除的 IMMessage 消息体列表
     * @param ignore 是否记录删除操作。从服务端拉取消息时，若存在该消息的本地删除记录（ignore 为 true），则该消息不会同步到数据库中。
     */
    void deleteChattingHistory(List<IMMessage> msgList, boolean ignore);
 
    /**
     * 清除指定用户的所有消息记录，不同步到数据库。
     *
     * @param account     用户账号（accid）
     * @param sessionType 会话类型
     */
    void clearChattingHistory(String account, SessionTypeEnum sessionType);
 
    /**
     * 清除指定用户的所有消息记录。
     *
     * @param account     用户账号（accid）
     * @param sessionType 会话类型
     * @param ignore 是否记录清除操作。从服务端拉取消息时，若存在该消息的本地清除记录（ignore 为 true），则该消息不会同步到数据库中。
     */
    void clearChattingHistory(String account, SessionTypeEnum sessionType, boolean ignore);
 
    /**
     * 清空消息数据库的所有消息记录，并指定是否要同时清空最近会话数据库。该方法为异步。 <br>
     * 若最近会话列表被清空，会触发 {@link MsgServiceObserve#observeRecentContactDeleted(Observer, boolean)} 回调通知。
     *
     * @param clearRecent 是否清空最近会话列表数据
     * @return InvocationFuture<Void> 可设置回调函数：清空成功后返回通知；清空失败后返回具体错误码。
     */
    InvocationFuture<Void> clearMsgDatabase(boolean clearRecent);
 
    /**
     * 单向删除指定消息，并同时单向删除服务端历史消息、漫游消息。该方法为异步。<br>
     * 用户单向删除一条消息成功后，该账号下不再能从服务端拉取到该条消息。而且，本端登录此账号的其他端都会删除本地的该消息记录。其他账号不受到该操作影响。删除成功后，会触发 {@link MsgServiceObserve#observeDeleteMsgSelf} 回调。
     *
     * @param msg 单向删除的 IMMessage 消息体
     * @param ext 消息扩展字段
     * @return InvocationFuture<Long> 可设置回调函数：成功后返回成功回调；失败后返回具体错误码。
     */
    InvocationFuture<Long> deleteMsgSelf(IMMessage msg, String ext);
 
    /**
     * 单向删除指定的消息列表，并同时单向删除服务端历史消息、漫游消息。该方法为异步。<br>
     * 用户单向删除消息列表成功后，该账号下不再能从服务端拉取到被删除消息。而且，本端登录此账号的其他端都会删除本地的该消息列表。其他账号不受到该操作影响。删除成功后，会触发 {@link MsgServiceObserve#observeDeleteMsgSelf} 回调。
     * @param msgList 单向删除的 IMMessage 消息体列表
     * @param ext 消息扩展字段
     * @return InvocationFuture<Long> 可设置回调函数：成功后返回成功回调；失败后返回具体错误码。
     */
    InvocationFuture<Long> deleteMsgSelf(List<IMMessage> msgList, String ext);
 
    /**
     * 查询指定消息是否存在本地删除记录。
     *
     * @param message 待查询的 IMMessage 消息体
     * @return 是否存在本地删除记录
     */
    boolean everBeenDeleted(IMMessage message);
 
    /**
     * 设置当前正在聊天的对象。<br>
     * 设置后会影响内建的消息提醒。如果有新消息到达，且消息来源是正在聊天的对象，将不会有消息提醒。<br>
     * 调用该接口的同时 SDK 会自动调用 {@link #clearUnreadCount(String, SessionTypeEnum)}，将正在聊天对象的未读数清零。
     *
     * @param account,    聊天对象账户（accid），或者以下两个值：<br>
     *                    {@link #MSG_CHATTING_ACCOUNT_ALL}<br>
     *                    {@link #MSG_CHATTING_ACCOUNT_NONE}
     * @param sessionType 会话类型。若 account 未设置为具体对象，则该参数不生效。
     */
    void setChattingAccount(String account, SessionTypeEnum sessionType);
 
    /**
     * 获取会话消息总未读数。
     *
     * @return 会话总未读数
     */
    int getTotalUnreadCount();
 
    /**
     * 根据免打扰状态获取会话消息总未读数。
     *
     * @param notify 是否获取免打扰会话的消息未读数：true 表示只查询排除免打扰之外的消息总未读数，false 表示只查询免打扰的消息总未读数。
     * @return 消息总未读数
     */
    int getTotalUnreadCount(boolean notify);
 
    /**
     * 获取指定类型的会话总未读数。
     *
     * @param sessionType 会话类型
     * @return 消息总未读数
     */
    int getUnreadCountBySessionType(SessionTypeEnum sessionType);
 
    /**
     * 获取指定会话的未读消息列表。该方法为异步。
     *
     * @param sessionId 会话ID
     * @param sessionType 会话类型
     * @return InvocationFuture<List<IMMessage>> 可设置回调函数：成功后返回消息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<IMMessage>> queryUnreadMessageList(String sessionId,SessionTypeEnum sessionType);
    /**
     * 获取指定会话的未读消息列表。该方法为同步。
     * @param sessionId 会话ID
     * @param sessionType 会话类型
     * @return List<IMMessage> 消息列表
     */
    List<IMMessage> queryUnreadMessageListBlock(String sessionId,SessionTypeEnum sessionType);
 
    /**
     * 将指定聊天对象的会话未读数清零（标记已读）。<br>
     * 调用该接口后，SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
     *
     * @param account     如果会话类型为单聊，则为聊天对象帐号（accid）；如果会话类型为群组或超大群，则为群组 ID。
     * @param sessionType 会话类型
     * @return InvocationFuture<Void> 可设置回调函数：清零成功后返回通知；清零失败后返回具体错误码。
     */
    InvocationFuture<Void> clearUnreadCount(String account, SessionTypeEnum sessionType);
 
    /**
     * 将指定聊天对象的会话未读数清零（标记已读）。该方法为异步。<br>
     * 调用该接口后，SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
     *
     * @param sessionKeyList     会话关键字列表。第一项为会话 ID，第二项为会话类型。
     *                           会话类型支持单聊（P2P）和群组（Team）。
     * @return InvocationFuture<List<SessionAckInfo>> 可设置回调函数：成功后返回会话关键信息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<SessionAckInfo>> clearUnreadCount(List<Pair<String, SessionTypeEnum>> sessionKeyList);
 
    /**
     * 将指定类型的会话未读数清零（标记已读）。该方法为异步。<br>
     * 调用该接口后，SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
     *
     * @param sessionType     会话类型，支持单聊（P2P）和群组（Team）。
     * @return InvocationFuture<List<SessionAckInfo>> 可设置回调函数：成功后返回会话关键信息列表；失败后返回具体错误码。
     */
    InvocationFuture<List<SessionAckInfo>> clearUnreadCount(SessionTypeEnum sessionType);
 
 
    /**
     * 将会话所有未读数清零（标记已读）。该接口为同步。<br>
     * 调用该接口后，SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
     */
    void clearAllUnreadCount();
 
    /**
     * 发送单聊消息已读回执。
     *
     * @param sessionId 会话 ID，即聊天对象账号（accid）。
     * @param message   已读的 IMMessage 消息体
     * @return InvocationFuture<Void> 可设置回调函数：发送成功后返回通知；发送失败后返回具体错误码。
     */
    InvocationFuture<Void> sendMessageReceipt(String sessionId, IMMessage message);
 
    /**
     * 更新消息属性。
     *
     * 可更新的属性如下：<br>
     *  - 消息状态 {@link IMMessage#getStatus()}
     *  - 附件状态 {@link IMMessage#getAttachStatus()}
     *  - 附件内容 {@link IMMessage#getAttachment()}
     *
     * @param message 待更新的 IMMessage 消息体
     */
    void updateIMMessageStatus(IMMessage message);
 
    /**
     * 更新消息。目前仅支持更新本地扩展字段 LocalExtension。
     *
     * @param message 待更新的 IMMessage 消息体
     */
    void updateIMMessage(IMMessage message);
 
    /**
     * 注册附件解析器。<br>
     *
     * <p>
     * 使用场景：
     * - 第三方 app 需要自定义的附件消息类型。
     * - 客户自定义的消息类型为{@link com.netease.nimlib.sdk.msg.constant.MsgTypeEnum#custom}。
     * - 自定义附件类型须继承自 {@link com.netease.nimlib.sdk.msg.attachment.MsgAttachment}。
     *
     * @param customParser 附件解析器
     */
    void registerCustomAttachmentParser(MsgAttachmentParser customParser);
 
    /**
     * 发送自定义系统通知。该接口为异步。<br>
     * 调用该接口后，SDK 会触发 {@link MsgServiceObserve#observeCustomNotification(Observer, boolean)} 回调通知。
     *
     * @param notification 自定义的系统通知
     * @return InvocationFuture<Void> 可设置回调函数：发送成功后返回通知；发送失败后返回具体错误码。
     */
    InvocationFuture<Void> sendCustomNotification(CustomNotification notification);
 
    /**
     * 查询全部最近会话。该接口为异步。
     *
     * @return InvocationFuture<List<RecentContact>> 可设置回调函数：成功后返回最近会话列表；失败后返回具体错误码。
     */
    InvocationFuture<List<RecentContact>> queryRecentContacts();
 
    /**
     * 查询全部最近会话。该接口为同步。
     *
     * @return List<RecentContact> 最近会话列表
     */
    List<RecentContact> queryRecentContactsBlock();
 
    /**
     * 查询指定数量的最近会话列表。该接口为异步。
     * <p>
     * 使用场景：
     * 最近会话数量较大。
     *
     * @param limit 本次查询最近会话的数量上限。最大可设置到 100，超过 100 则默认为 100。
     * @return InvocationFuture<List<RecentContact>> 可设置回调函数：成功后返回指定数量的最近会话列表；失败后返回具体错误码。
     */
    InvocationFuture<List<RecentContact>> queryRecentContacts(int limit);
 
 
    /**
     * 分页查询指定数量的最近会话列表。该接口为异步。
     * @param anchor 查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。<br>
     *               每次查询传入上一页数据的最后一个 RecentContact。<br>
     *               首次查询传 null 即可。<br>
     *               首次查询当查询方向 direction 为 QUERY_NEW 时，则从 0 开始查询；
     *               首次查询当查询方向 direction 为 QUERY_OLD 时，则从当前系统时间开始查询。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit 查询的消息条数限制（最大为 100）
     * @return InvocationFuture<List<RecentContact>> 可设置回调函数：成功后分页返回最近会话列表；失败后返回具体错误码。
     */
    InvocationFuture<List<RecentContact>> queryRecentContacts(RecentContact anchor,QueryDirectionEnum direction,int limit);
 
    /**
     * 查询指定数量的最近会话列表。该接口为同步。
     *
     * @param limit 本次查询最近会话的数量上限。最大可设置到 100，超过 100 则默认为 100。
     * @return List<RecentContact> 指定数量的最近会话列表。
     */
    List<RecentContact> queryRecentContactsBlock(int limit);
 
    /**
     * 分页查询指定数量的最近会话列表。该接口为同步。
     * @param anchor 查询锚点消息，作为查询起始点（不包含锚点），单位毫秒。<br>
     *               每次查询传入上一页数据的最后一个 RecentContact。<br>
     *               首次查询传 null 即可。<br>
     *               首次查询当查询方向 direction 为 QUERY_NEW 时，则从 0 开始查询；
     *               首次查询当查询方向 direction 为 QUERY_OLD 时，则从当前系统时间开始查询。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param limit 查询的消息条数限制（最大为 100）
     * @return List<RecentContact> 分页返回最近会话列表
     */
    List<RecentContact> queryRecentContactsBlock(RecentContact anchor,QueryDirectionEnum direction,int limit);
 
 
    /**
     * 过滤指定消息类型的会话，例如过滤文本消息，则返回最近一条非文本消息的会话。该接口为异步。
     *
     * @param filterMsgType 过滤的消息类型
     * @return InvocationFuture<List<RecentContact>> 可设置回调函数：成功后返回最近会话列表；失败后返回具体错误码。
     */
    InvocationFuture<List<RecentContact>> queryRecentContacts(MsgTypeEnum filterMsgType);
 
    /**
     * 过滤指定消息类型的会话，例如过滤文本消息，则返回最近一条非文本消息的会话。该接口为同步。
     *
     * @param filterMsgType 过滤的消息类型
     * @return List<RecentContact> 过滤后的最近会话列表
     */
    List<RecentContact> queryRecentContactsBlock(MsgTypeEnum filterMsgType);
 
 
    /**
     * 查过滤指定消息类型的会话，例如过滤文本和音频消息，则返回最近一条非文本或音频消息的会话。该接口为异步。
     *
     * @param filterMsgTypeSet 过滤的消息类型列表
     * @return InvocationFuture<List<RecentContact>> 可设置回调函数：成功后返回最近会话列表；失败后返回具体错误码。
     */
    InvocationFuture<List<RecentContact>> queryRecentContacts(Set<MsgTypeEnum> filterMsgTypeSet);
 
    /**
     * 查过滤指定消息类型的会话，例如过滤文本和音频消息，则返回最近一条非文本或音频消息的会话。该接口为同步。
     *
     * @param filterMsgTypeSet 过滤的消息类型列表
     * @return List<RecentContact> 过滤后的最近会话列表
     */
    List<RecentContact> queryRecentContactsBlock(Set<MsgTypeEnum> filterMsgTypeSet);
 
    /**
     * 更新指定的最近会话。<br>
     * 如需收到更新的回调通知，可使用 {@link MsgService#updateRecentAndNotify(RecentContact)}。
     *
     * @param recent 最近会话对象
     */
    void updateRecent(RecentContact recent);
 
 
    /**
     * 更新指定的最近会话。<br>
     * 更新成功后，SDK 会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知 。
     *
     * @param recent 最近会话对象
     */
    void updateRecentAndNotify(RecentContact recent);
 
 
    /**
     * 更新指定消息所属的最近会话。
     *
     * @param message    IMMessage 消息体
     * @param needNotify 是否需要触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知
     */
    void updateRecentByMessage(IMMessage message, boolean needNotify);
 
 
    /**
     * 根据是否有更多漫游消息的标记更新最近会话。
     *
     * @param newTag IMMessage 消息题
     */
    void updateRoamMsgHasMoreTag(IMMessage newTag);
 
    /**
     * 删除指定的最近会话记录，包括本地最近会话和漫游消息。<br>
     * 调用该接口删除后，不会返回回调通知。
     *
     * @param recent 待删除的最近联系人会话项
     */
    void deleteRecentContact(RecentContact recent);
 
    /**
     * 删除指定聊天对象和会话类型的最近会话记录，包括本地最近会话和漫游消息。<br>
     * 调用该接口删除后，会触发 {@link MsgServiceObserve#observeRecentContactDeleted(Observer, boolean)} 回调通知。
     *
     * @param account 如果会话类型为单聊，则为聊天对象账号（accid）；如果会话类型为群组或超大群，则为群组 ID。
     * @param sessionType 会话类型
     */
    void deleteRecentContact2(String account, SessionTypeEnum sessionType);
 
    /**
     * 删除指定会话的漫游消息。<br>
     * 不删除本地消息，如果在其他端登录，当前时间点该会话已经产生的消息不漫游。
     *
     * @param contactId       会话 ID。如果会话类型为单聊，则为聊天对象账号（accid）；如果会话类型为群组，则为群组 ID。
     * @param sessionTypeEnum 会话类型
     * @return InvocationFuture<Void> 可设置回调函数：删除成功后返回通知；删除失败后返回具体错误码。
     */
    InvocationFuture<Void> deleteRoamingRecentContact(String contactId, SessionTypeEnum sessionTypeEnum);
 
    /**
     * 删除最近联系人记录。<br>
     * 调用该接口后，不会触发{@link MsgServiceObserve#observeRecentContactDeleted(Observer, boolean)}通知
     *
     * @param account     如果会话类型为单聊，则为聊天对象账号（accid）；如果会话类型为群组，则为群组 ID。
     * @param sessionType 会话类型，仅支持设置为单聊（P2P）和群组（Team）。
     * @param deleteType  删除类型，设置删除本地记录或漫游记录，默认为均不删除。
     * @param sendAck     是否向其他端发送已读回执
     * @return InvocationFuture<Void> 可设置回调函数：删除成功后返回通知；删除失败后返回具体错误码。
     */
    InvocationFuture<Void> deleteRecentContact(String account, SessionTypeEnum sessionType, DeleteTypeEnum deleteType, boolean sendAck);
 
    /**
     * 根据是否有更多漫游消息的标记删除指定会话。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     */
    void deleteRoamMsgHasMoreTag(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 语音转文字。
     *
     * @param voiceUrl 语音文件 URL
     * @param path     语音文件本地路径。请确保语音文件已下载到本地。
     * @param duration 语音时长
     * @return AbortableFuture<String> 可设置回调函数监听，随时中止操作：成功后返回字符串；失败后返回具体错误码。
     */
    AbortableFuture<String> transVoiceToText(String voiceUrl, String path, long duration);
 
    /**
     * 语音转文字并指定上传文件的场景。
     *
     * @param voiceUrl 语音文件 URL
     * @param path     语音文件本地路径。请确保语音文件已下载到本地。
     * @param duration 语音时长
     * @param sceneKey 上传文件时使用的 nos sceneKey，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}。详见 {@link NosTokenSceneConfig}。
     * @return AbortableFuture<String> 可设置回调函数监听，随时中止操作：成功后返回字符串；失败后返回具体错误码。
     */
    AbortableFuture<String> transVoiceToTextAtScene(String voiceUrl, String path, long duration, String sceneKey);
 
 
    /**
     * 语音转文字并指定上传文件的场景，以及是否要强制重新上传文件。
     *
     * @param voiceUrl              语音文件 URL
     * @param path                  语音文件本地路径。请确保语音文件已下载到本地。
     * @param duration              语音时长
     * @param sceneKey              上传文件时使用的 nos sceneKey，默认为 {@link NimNosSceneKeyConstant#NIM_DEFAULT_IM}。详见 {@link NosTokenSceneConfig}。
     * @param enableForceUploadFile 如果服务器存在相同的文件，是否强制重新上传文件，默认为 false。
     * @return AbortableFuture<String> 可设置回调函数监听，随时中止操作：成功后返回字符串；失败后返回具体错误码。
     */
    AbortableFuture<String> transVoiceToTextEnableForce(String voiceUrl, String path, long duration, String sceneKey,
                                                        boolean enableForceUploadFile);
 
    /**
     * 搜索指定聊天对象的漫游消息。
     *
     * @param otherAccid 聊天对象账号（accid）
     * @param fromTime 搜索起始时间，单位毫秒。
     * @param endTime 搜索结束时间点，单位毫秒。
     * @param keyword 搜索关键词
     * @param limit 本次查询的消息条数上限（最多 100）
     * @param reverse 是否反转，true 表示按时间倒序搜索，false 表示按时间正序搜索，默认为 false。
     * @return InvocationFuture<ArrayList<IMMessage>> 可设置回调函数监听：成功后返回漫游消息列表；失败后返回具体错误码。
     */
    InvocationFuture<ArrayList<IMMessage>> searchRoamingMsg(String otherAccid, long fromTime, long endTime, String keyword, int limit, boolean reverse);
 
    /**
     * 注册通知类消息的过滤器。
     *
     * @param filter 通知类消息的过滤器，决定是否过滤通知消息（即不存储到数据库中）。<br>
     *               传 null 表示注销通知消息过滤器。
     */
    void registerIMMessageFilter(IMMessageFilter filter);
 
    /**
     * 注册在撤回消息时展示通知类消息的过滤器。
     *
     * @param filter 通知类消息的过滤器，决定是否在撤回消息时展示通知类消息的过滤器。<br>
     *               传 null 表示展示通知类消息的过滤器。
     */
    void registerShouldShowNotificationWhenRevokeFilter(ShowNotificationWhenRevokeFilter filter);
 
    /**
     * 撤回指定的消息。<br>
     * 默认不包含第三方推送消息（包括 iOS 推送）。
     *
     * @param message 待撤回的 IMMessage 消息体
     * @return InvocationFuture<Void>  可设置回调函数：撤回成功后返回通知；撤回失败后返回具体错误码。
     */
    InvocationFuture<Void> revokeMessage(IMMessage message);
 
 
    /**
     * 撤回指定的消息，并设置第三方推送属性（包括 iOS 推送）。<br>
     *
     * @param message        待撤回的 IMMessage 消息体
     * @param customApnsText 第三方推送文本
     * @param pushPayload    第三方推送属性，仅支持 JSON 格式，长度上限为 2048。
     * @return InvocationFuture<Void> 可设置回调函数：撤回成功后返回通知；撤回失败后返回具体错误码。
     */
    InvocationFuture<Void> revokeMessageEx(IMMessage message, String customApnsText, Map<String, Object> pushPayload);
 
 
    /**
     * 撤回指定的消息，并设置第三方推送属性（包括 iOS 推送），及是否更新未读数。
     *
     * @param message        待撤回的 IMMessage 消息体
     * @param customApnsText 第三方推送文本
     * @param pushPayload    第三方推送属性，仅支持 JSON 格式，长度上限为 2048。
     * @param shouldNotifyBeCount 是否更新未读数
     * @return InvocationFuture<Void> 可设置回调函数：撤回成功后返回通知；撤回失败后返回具体错误码。
     */
    InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
                                         Map<String, Object> pushPayload, boolean shouldNotifyBeCount);
 
    /**
     * 撤回指定的消息，并设置第三方推送属性（包括 iOS 推送）、附言，及是否更新未读数。
     *
     * @param message        待撤回的 IMMessage 消息体
     * @param customApnsText 第三方推送文本
     * @param pushPayload    第三方推送属性，仅支持 JSON 格式，长度上限为 2048。
     * @param shouldNotifyBeCount 是否更新未读数
     * @param postscript 附言信息
     * @return InvocationFuture<Void> 可设置回调函数：撤回成功后返回通知；撤回失败后返回具体错误码。
     */
    InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
                                         Map<String, Object> pushPayload, boolean shouldNotifyBeCount,
                                         String postscript);
 
    /**
     * 撤回指定的消息，并设置第三方推送属性（包括 iOS 推送）、附言、扩展信息，及是否更新未读数。
     *
     * @param message        待撤回的 IMMessage 消息体
     * @param customApnsText 第三方推送文本
     * @param pushPayload    第三方推送属性，仅支持 JSON 格式，长度上限为 2048。
     * @param shouldNotifyBeCount 是否更新未读数
     * @param postscript 附言
     * @param attach 扩展字段
     * @return InvocationFuture<Void> 可设置回调函数：撤回成功后返回通知；撤回失败后返回具体错误码。
     */
    InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
                                         Map<String, Object> pushPayload, boolean shouldNotifyBeCount,
                                         String postscript, String attach);
 
    /**
     * 批量导入最近会话，仅支持 contactId 和 sessionType 两个字段
     *
     * @param sessions 会话列表。由 contactId(会话 ID) 和 SessionTypeEnum(会话类型)两个字段组成。
     * @return InvocationFuture<Void> 可设置回调函数：导入成功后返回通知；导入失败后返回具体错误码。
     */
    InvocationFuture<Void> importRecentSessions(List<Pair<String, SessionTypeEnum>> sessions);
 
 
    /**
     * 检验本地反垃圾词库。
     *
     * @param content     待检查的文本
     * @param replacement 反垃圾词库命中后的替换文本
     * @return 检验结果 LocalAntiSpamResult 对象
     */
    LocalAntiSpamResult checkLocalAntiSpam(String content, String replacement);
 
    /**
     * 创建一条空的最近会话。
     *
     * @param contactId   会话 ID，聊天对方帐号或群组 ID。
     * @param sessionType 会话类型
     * @param tag         会话标签。例如置顶标签，如不需要可传 0。
     * @param time        会话时间戳，单位为毫秒。
     * @param saveToDB    是否需要将会话保存在数据库中：<br>
     *                    - 如果已经存在相同会话，则不保存。<br>
     *                    - 如果之前不存在相同会话，保存到数据库后会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
     *
     * @return InvocationFuture<RecentContact> 可设置回调函数：创建成功后返回最近会话；创建失败后返回具体错误码。
     */
    RecentContact createEmptyRecentContact(String contactId, SessionTypeEnum sessionType, long tag, long time,
                                           boolean saveToDB);
 
    /**
     * 创建一条空的最近会话。
     *
     * @param contactId   会话 ID，聊天对方帐号或群组 ID。
     * @param sessionType 会话类型
     * @param tag         会话标签。例如置顶标签，如不需要可传 0。
     * @param time        会话时间戳，单位为毫秒。
     * @param saveToDB    是否需要将会话保存在数据库中：<br>
     *                    - 如果已经存在相同会话，则不保存。<br>
     *                    - 如果之前不存在相同会话，保存到数据库后会触发 {@link MsgServiceObserve#observeRecentContact(Observer, boolean)} 回调通知。
     * @param withLastMsg 是否包含最后一条消息的相关信息
     * @return InvocationFuture<RecentContact> 可设置回调函数：创建成功后返回最近会话；创建失败后返回具体错误码。
     */
    RecentContact createEmptyRecentContact(String contactId, SessionTypeEnum sessionType, long tag, long time,
                                           boolean saveToDB, boolean withLastMsg);
 
 
    /**
     * 查询指定的会话记录。
     *
     * @param contactId   会话 ID，聊天对象帐号或群组 ID。
     * @param sessionType 会话类型
     * @return RecentContact 最近会话
     */
    RecentContact queryRecentContact(String contactId, SessionTypeEnum sessionType);
 
 
    /**
     * 取消上传消息附件（图片、视频、文件类型）。<br/>
     * 如果成功取消了附件的上传，对应的消息会发送失败，消息状态是 {@link MsgStatusEnum#fail}，附件状态是 {@link AttachStatusEnum#cancel}。<br>
     * <p>
     * 注意事项
     * 此方法暂时不支持聊天室。
     *
     * @param imMessage 取消上传附件的 IMMessage 消息体
     * @return InvocationFuture<Void> 可设置回调函数：取消成功后返回通知；取消失败后返回具体错误码。
     */
    InvocationFuture<Void> cancelUploadAttachment(IMMessage imMessage);
 
 
    /**
     * 导出本地所有历史消息。导出消息类型包括：文本消息 、图片消息、 音频消息、 视频消息 、文件消息、自定义消息。<br/>
     * 如果有服务端消息记录，不建议使用该接口。<br/>
     * 整个过程如下：<br/>
     * step1 : 消息转换成文件 <br/>
     * step2 : 压缩文件（用户自定义过程） <br/>
     * step3 : 加密文件（用户自定义过程）<br/>
     * step4 : 上传文件  <br/><br/>
     * 错误码：<br/>
     * DB中没有数据 : {@link MigrationConstant#EXPORT_ERR_DB_EMPTY}<br/>
     * 本地消息格式化失败 : {@link MigrationConstant#EXPORT_ERR_LOCAL_FORMAT}<br/>
     * 文件压缩失败(用户自定义过程) : {@link MigrationConstant#EXPORT_ERR_USER_CUSTOM_ZIP}<br/>
     * 消息导出时，文件加密失败(用户自定义过程) : {@link MigrationConstant#EXPORT_ERR_USER_CUSTOM_ENCRYPT}<br/>
     * 上传文件失败 : {@link MigrationConstant#EXPORT_ERR_UPLOAD_FILE}<br/>
     * 消息导出时，本地有消息，但是都被过滤了 : {@link MigrationConstant#EXPORT_ERR_EMPTY_AFTER_FILTER}<br/>
     *
     * @param exportProcessor 消息导出处理器
     * @param safeMode        是否为安全模式，安全模式下处理完成后会删除相关的文件（包括用户自定义过程的）
     * @return AbortableFuture<Void> 可设置回调函数：导出成功后返回通知，可随时中断导入；导出失败后返回具体错误码。
     */
    AbortableFuture<Void> exportAllMessage(IMsgExportProcessor exportProcessor, boolean safeMode);
 
 
    /**
     * 导入已导出的历史消息。
     *
     * 该方法用于端到端的历史消息迁移，请先调用 {@link MsgService#exportAllMessage(IMsgExportProcessor, boolean safeMode)} 导出历史消息。<br/>
     * 导入步骤：<br/>
     * step1 : 请求服务器，下载备份文件。 <br/>
     * step2 : 解密文件（用户自定义过程）。 <br/>
     * step3 : 解压缩文件（用户自定义过程）。<br/>
     * step4 : 解析文件。<br/>
     * 错误码：<br/>
     * 服务端上没有备份记录 : {@link MigrationConstant#IMPORT_ERR_NO_BACKUP}<br/>
     * 服务端返回了备份记录，可是为空 : {@link MigrationConstant#IMPORT_ERR_RECORD_EMPTY}<br/>
     * 文件下载失败 : {@link MigrationConstant#IMPORT_ERR_DOWN_FILE}<br/>
     * 文件解密失败(用户自定义过程) : {@link MigrationConstant#IMPORT_ERR_CUSTOM_DECRYPT}<br/>
     * 文件解压缩失败(用户自定义过程) : {@link MigrationConstant#IMPORT_ERR_CUSTOM_UNZIP}<br/>
     * 文件格式错误 : {@link MigrationConstant#IMPORT_ERR_FILE_FORMAT}<br/>
     * 部分成功: {@link MigrationConstant#IMPORT_ERR_PART_SUCCESS}<br/>
     *
     * @param iMsgImportProcessor 消息导入处理器
     * @param safeMode            是否为安全模式。安全模式下处理完成后会删除相关的文件（包括用户自定义过程的）。
     * @return AbortableFuture<Void> 可设置回调函数：导入成功后返回通知，可随时中断导入；导入失败后返回具体错误码。
     */
    AbortableFuture<Void> importAllMessage(IMsgImportProcessor iMsgImportProcessor, boolean safeMode);
 
    /**
     * 清空服务端单聊历史消息，并指定是否删除漫游消息。
     *
     * @param sessionId   会话 ID，即聊天对象用户账号（accid）
     * @param deleteRoam  是否删除漫游消息
     */
    void clearServerHistory(String sessionId, boolean deleteRoam);
 
 
    /**
     * 清空服务端单聊历史消息，默认删除漫游消息。
     *
     * @param sessionId   会话 ID，即聊天对象用户账号（accid）
     * @param sessionType 聊天类型，仅支持单聊
     */
    void clearServerHistory(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 清空服务端单聊历史消息。
     *
     * @param sessionId   会话 ID，即聊天对象用户账号（accid）
     * @param sessionType 聊天类型
     * @param deleteRoam  是否删除漫游消息
     * @deprecated 仅当P2P时，支持保留漫游消息。
     * 如果要保留漫游消息，请使用{@link MsgService#clearServerHistory(String, boolean)}
     * 如果不保留漫游消息，请使用{@link MsgService#clearServerHistory(String, SessionTypeEnum)}
     */
    void clearServerHistory(String sessionId, SessionTypeEnum sessionType, boolean deleteRoam);
 
    /**
     * 清空服务端指定会话的历史消息。
     *
     * @param sessionId     会话 ID
     * @param sessionType 会话类型
     * @param sync 是否多端同步
     * @param ext 扩展字段
     */
    void clearServerHistory(String sessionId, SessionTypeEnum sessionType, boolean sync, String ext);
 
 
    /**
     * 根据时间范围删除指定用户的本地历史消息。
     *
     * @param account     用户账号（accid）
     * @param sessionType 删除会话类型
     * @param startTime   开始时间（不包含）
     * @param endTime     结束时间（不包含）
     */
    void deleteRangeHistory(String account, SessionTypeEnum sessionType, long startTime, long endTime);
 
    /**
     * 分页获取服务端指定会话列表。
     *
     * @deprecated 该方法已废弃，请使用 {@link MsgService#queryMySessionList(QueryMySessionOption)}。
     *
     * @param minTimestamp 最小时间戳，作为请求参数时表示增量获取Session列表，传0表示全量获取
     * @param maxTimestamp 最大时间戳，翻页时使用
     * @param needLastMsg  是否需要最后一条消息
     * @param limit        本次查询条数上线，最大为 100，默认为 100。
     * @param hasMore      预留字段
     * @return InvocationFuture
     *
     */
    InvocationFuture<RecentSessionList> queryMySessionList(long minTimestamp, Long maxTimestamp, Integer needLastMsg, Integer limit, Integer hasMore);
 
    /**
     * 分页获取服务端指定会话列表。
     *
     * @param option 查询参数
     * @return InvocationFuture<RecentSessionList> 可设置回调函数：获取成功后返回会话；获取失败后返回具体错误码。
     */
    InvocationFuture<RecentSessionList> queryMySessionList(QueryMySessionOption option);
 
    /**
     * 获取服务端指定会话。
     *
     * @param sessionId 会话 ID，格式分别是：p2p|accid、team|tid、super_team|tid，不可为空
     * @return InvocationFuture<RecentSession> 可设置回调函数：获取成功后返回会话；获取失败后返回具体错误码。
     * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
     */
    InvocationFuture<RecentSession> queryMySession(@NonNull String sessionId);
 
    /**
     * 更新服务端会话扩展字段。
     *
     * @param sessionId 会话 ID，格式分别是：p2p|accid、team|tid、super_team|tid
     * @param ext       会话的扩展字段，仅自己可见
     * @return InvocationFuture<Void> 可设置回调函数：更新成功后返回通知；更新失败后返回具体错误码。
     * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
     */
    InvocationFuture<Void> updateMySession(@NonNull String sessionId, @NonNull String ext);
 
    /**
     * 删除服务端指定会话。
     *
     * @param sessionIdArr 每一项的格式：分为p2p/team/superTeam，格式分别是：p2p|accid、team|tid、super_team|tid。
     * @return InvocationFuture<Void> 可设置回调函数：删除成功后返回通知；删除失败后返回具体错误码。
     * @see com.netease.nimlib.biz.constant.ITalkService.SessionTag
     */
    InvocationFuture<Void> deleteMySession(@NonNull String[] sessionIdArr);
 
    /**
     * 查询服务端 Thread 历史消息（支持单聊、群、超大群）。
     *
     * @param anchor 查询锚点消息，锚点为指定的 Thread 消息。
     * @param fromTime 查询起始时间
     * @param toTime 查询终止时间
     * @param limit 本次查询条数限制
     * @param direction 查询方向：早于或晚于锚点。
     * @param persist 查询结果是否同步到本地数据库。
     * @return InvocationFuture<ThreadTalkHistory> 可设置回调函数：查询成功后返回 Thread 历史消息；查询失败后返回具体错误码。
     */
    InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(IMMessage anchor, long fromTime, long toTime,
                                                               int limit, QueryDirectionEnum direction, boolean persist);
 
    /**
     * 查询服务端 Thread 历史消息（支持单聊、群、超大群）。
     *
     * @param threadMessageKey 要查询的Thread的顶部消息的{@link MessageKey}。
     * @param option 分页参数
     * @return InvocationFuture<ThreadTalkHistory> 可设置回调函数：查询成功后返回 Thread 历史消息；查询失败后返回具体错误码。
     */
    InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(MessageKey threadMessageKey, QueryThreadTalkHistoryOption option);
 
    /**
     * 获取指定 Thread 的回复消息条数。
     *
     * <p>
     * 前提条件 已联系商务经理开通 Thread 消息功能。
     *
     * @param msg Thread 消息，该消息不计入总数。
     * @return 回复消息数
     */
    int queryReplyCountInThreadTalkBlock(IMMessage msg);
 
    /**
     * 添加一条快捷评论。
     *
     * @param msg 回复的 IMMessage 消息
     * @param replyType 回复类型
     * @param ext 自定义扩展字段，最大 8 字符。
     * @return InvocationFuture<Void> 可设置回调函数：添加成功后返回通知；添加失败后返回具体错误码。
     */
    InvocationFuture<Void> addQuickComment(IMMessage msg, long replyType, String ext);
 
    /**
     * 添加一条快捷评论并设置推送。
     *
     * @param msg 回复的 IMMessage 消息
     * @param replyType 回复类型
     * @param ext 自定义扩展字段，最大 8 字符。
     * @param needPush 是否需要推送
     * @param needBadge 是否需要角标
     * @param pushTitle 推送标题
     * @param pushContent 推送内容
     * @param pushPayload 第三方推送属性，仅支持 JSON 类型。
     * @return InvocationFuture<Long> 可设置回调函数：添加成功后返回通知；添加失败后返回具体错误码。
     */
    InvocationFuture<Long> addQuickComment(IMMessage msg, long replyType, String ext, boolean needPush,
                                           boolean needBadge, String pushTitle, String pushContent,
                                           Map<String, Object> pushPayload);
 
    /**
     * 删除一条快捷评论。
     *
     * @param msg 回复的 IMMessage 消息
     * @param replyType 回复类型
     * @param ext 自定义扩展字段，最大 8 字符。
     * @return InvocationFuture<Void> 可设置回调函数：删除成功后返回通知；删除失败后返回具体错误码。
     */
    InvocationFuture<Void> removeQuickComment(IMMessage msg, long replyType, String ext);
 
    /**
     * 删除一条快捷评论并设置推送。
     *
     * @param msg 回复的 IMMessage 消息
     * @param replyType 回复类型
     * @param ext 自定义扩展字段，最大 8 字符。
     * @param needPush 是否需要消息推送
     * @param needBadge 是否需要角标
     * @param pushTitle 推送标题
     * @param pushContent 推送内容
     * @param pushPayload 第三方推送属性，仅支持 JSON 类型。
     * @return InvocationFuture<Long> 可设置回调函数：删除成功后返回通知；删除失败后返回具体错误码。
     */
    InvocationFuture<Long> removeQuickComment(IMMessage msg, long replyType, String ext, boolean needPush,
                                              boolean needBadge, String pushTitle, String pushContent,
                                              Map<String, Object> pushPayload);
    /**
     * 获取消息的快捷评论列表。
     *
     * @param msgList 消息列表，最多为 20 条。
     * @return InvocationFuture<List<QuickCommentOptionWrapper>> 可设置回调函数：获取成功后返回收藏列表信息；获取失败后返回具体错误码。
     */
    InvocationFuture<List<QuickCommentOptionWrapper>> queryQuickComment(List<IMMessage> msgList);
 
    /**
     * 添加一条收藏。
     *
     * @param type 收藏类型
     * @param date 收藏数据，最大长度为 20k 字符。
     * @param ext 扩展字段，最大长度为 1k 字符。
     * @param uniqueId 去重 ID，如果多个收藏具有相同的去重 ID，则视为同一条收藏
     * @return InvocationFuture<CollectInfo> 可设置回调函数：添加成功后返回收藏列表信息；添加失败后返回具体错误码。
     */
    InvocationFuture<CollectInfo> addCollect(int type, String date, String ext, String uniqueId);
 
    /**
     * 批量移除收藏列表。
     *
     * @param collectInfo 待移除的收藏的关键信息组成的列表，每一项为一个Pair，其中第一项为收藏 ID，第二项为收藏的创建时间。
     * @return InvocationFuture<Integer> 可设置回调函数：移除成功后返回通知；更新失败后返回具体错误码。
     */
    InvocationFuture<Integer> removeCollect(List<Pair<Long, Long>> collectInfo);
 
    /**
     * 更新一个收藏列表的扩展字段。
     *
     * @param info 收藏 ID，由服务端生成，具有唯一性。
     * @param ext 更新后的扩展字段
     * @return InvocationFuture<CollectInfo> 可设置回调函数：更新成功后返回收藏列表信息；更新失败后返回具体错误码。
     */
    InvocationFuture<CollectInfo> updateCollect(CollectInfo info, String ext);
 
    /**
     * 更新一个指定创建时间的收藏列表的扩展字段。
     *
     * @param infoId 收藏 ID，由服务端生成，具有唯一性。
     * @param createTime 收藏列表创建时间
     * @param ext 更新后的扩展字段
     * @return InvocationFuture<CollectInfo> 可设置回调函数：更新成功后返回收藏列表信息；更新失败后返回具体错误码。
     */
    InvocationFuture<CollectInfo> updateCollect(long infoId, long createTime, String ext);
 
    /**
     * 从服务查询消息收藏列表。
     *
     * @param limit 本次查询的条数上限，最多为 100。
     * @return InvocationFuture<CollectInfoPage> 可设置回调函数：查询成功后返回收藏列表；添加失败后返回具体错误码。
     */
    InvocationFuture<CollectInfoPage> queryCollect(int limit);
 
    /**
     * 分页查询服务端消息收藏列表。
     *
     * @param anchor 查询锚点消息，作为查询起始点（不包含锚点）。
     * @param toTime 查询结束时间点，单位毫秒。
     * @param limit 本次查询的条数上限，最多为 100。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @return InvocationFuture<CollectInfoPage> 可设置回调函数：查询成功后返回收藏列表；添加失败后返回具体错误码。
     */
    InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction);
 
    /**
     * 按照收藏类型分页查询服务端消息收藏列表。
     *
     * @param anchor 查询锚点消息，作为查询起始点（不包含锚点）。
     * @param toTime 查询结束时间点，单位毫秒。
     * @param limit 本次查询的条数上限，最多为 100。
     * @param direction 查询方向：查询早于 anchor 消息或晚于 anchor 消息。
     * @param type 收藏类型
     * @param persist 查询的收藏消息是否同步到本地数据库。
     * @return InvocationFuture<CollectInfoPage> 可设置回调函数：查询成功后返回收藏列表；添加失败后返回具体错误码。
     */
    InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction, int type, boolean persist);
 
    /**
     * 添加一条 PIN 消息。
     *
     * @param msg 被 PIN 标记的 IMMessage 消息体
     * @param ext 扩展字段
     * @return InvocationFuture<Long> 可设置回调函数：添加成功后返回通知；添加失败后返回具体错误码。
     */
    InvocationFuture<Long> addMsgPin(IMMessage msg, String ext);
 
    /**
     * 更新一条 PIN 消息。
     *
     * @param msg 被 PIN 标记的 IMMessage 消息体
     * @param ext 扩展字段
     * @return InvocationFuture<Long> 可设置回调函数：更新成功后返回通知；更新失败后返回具体错误码。
     */
    InvocationFuture<Long> updateMsgPin(IMMessage msg, String ext);
 
    /**
     * 移除一条 PIN 消息标记。
     *
     * @param msg 被 PIN 标记的 IMMessage 消息体
     * @param ext 扩展字段
     * @return InvocationFuture<Long> 可设置回调函数：移除成功后返回通知；移除失败后返回具体错误码。
     */
    InvocationFuture<Long> removeMsgPin(IMMessage msg, String ext);
 
    /**
     * 同步会话的 PIN 消息。
     *
     * @param sessionType 会话类型
     * @param sessionId   会话 ID
     * @param timestamp   消息时间戳，同步该时间戳以后的 PIN 消息。
     * @return InvocationFuture<MsgPinSyncResponseOptionWrapper> 可设置回调函数：同步成功后返回 PIN 消息；同步失败后返回具体错误码。
     */
    InvocationFuture<MsgPinSyncResponseOptionWrapper> syncMsgPin(SessionTypeEnum sessionType, String sessionId, long timestamp);
 
    /**
     * 获取本地会话的 PIN 消息列表。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     * @return List<MsgPinDbOption> PIN 消息列表
     */
    List<MsgPinDbOption> queryMsgPinBlock(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 添加一个置顶会话。
     *
     * @param sessionId   会话 ID
     * @param sessionType 会话类型
     * @param ext         扩展字段，最大 512 字符。
     * @return InvocationFuture<StickTopSessionInfo> 可设置回调函数：添加成功后返回置顶会话信息；添加失败后返回具体错误码。
     */
    InvocationFuture<StickTopSessionInfo> addStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);
 
    /**
     * 移除一个置顶会话。
     *
     * @param sessionId   会话 ID
     * @param sessionType 会话类型
     * @param ext         扩展字段，最大 512 字符。
     * @return InvocationFuture<Void> 可设置回调函数：移除成功后返回通知；移除失败后返回具体错误码。
     */
    InvocationFuture<Void> removeStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);
 
    /**
     * 更新一个置顶会话的扩展字段。
     *
     * @param sessionId   会话 ID
     * @param sessionType 会话类型
     * @param ext         扩展字段，最大为 512 字符
     * @return InvocationFuture<StickTopSessionInfo> 可设置回调函数：更新成功后返回置顶会话信息；更新失败后返回具体错误码。
     */
    InvocationFuture<StickTopSessionInfo> updateStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);
 
    /**
     * 获取置顶会话信息列表。该方法为同步。
     *
     * @return List<StickTopSessionInfo> 置顶会话信息列表
     */
    List<StickTopSessionInfo> queryStickTopSessionBlock();
 
 
    /**
     * 获取会话是否被置顶。
     *
     * @param sessionId 会话 ID
     * @param sessionType 会话类型
     * @return 该会话是否被置顶。如果会话 ID 或会话类型为 "" 或 null，或不合法不存在，则返回 false。
     */
    boolean isStickTopSession(String sessionId, SessionTypeEnum sessionType);
 
    /**
     * 迁移历史消息。<br>
     * 调用该方法将消息发送端的历史消息迁移到消息接收端的数据库中，包括消息内容和联系人信息。
     *
     * @param from       消息发送端用户账号（accid）
     * @param to         消息接收端用户账号（accid）
     * @param changeFrom 是否将历史消息 IMMessage 的 fromAccount 改为消息接收端用户账号（to）
     */
    void migrateMessages(String from, String to, boolean changeFrom);
}