V2NIMLocalConversationService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.conversation;

import androidx.annotation.NonNull;
import com.netease.nimlib.sdk.v2.V2NIMError;
import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.V2NIMSyncResult;
import com.netease.nimlib.sdk.v2.conversation.enums.V2NIMConversationType;
import com.netease.nimlib.sdk.v2.conversation.model.V2NIMLocalConversation;
import com.netease.nimlib.sdk.v2.conversation.option.V2NIMLocalConversationOption;
import com.netease.nimlib.sdk.v2.conversation.params.V2NIMLocalConversationFilter;
import com.netease.nimlib.sdk.v2.conversation.result.V2NIMLocalConversationOperationResult;
import com.netease.nimlib.sdk.v2.conversation.result.V2NIMLocalConversationResult;
import java.util.List;

public interface V2NIMLocalConversationService {

    /**
     * 获取本地会话列表
     *
     * @param offset  分页偏移，首次传0，后续拉取采用上一次返回的offset
     * @param limit   分页拉取数量，不建议超过100;
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getConversationList(long offset, int limit, V2NIMSuccessCallback<V2NIMLocalConversationResult> success, V2NIMFailureCallback failure);

    /**
     * 获取本地会话列表
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     * @param offset  分页偏移，首次传0，后续拉取采用上一次返回的offset
     * @param limit   分页拉取数量，不建议超过100;
     */
    V2NIMSyncResult<V2NIMLocalConversationResult> getConversationList(long offset, int limit);

    /**
     * 根据查询参数获取本地会话列表
     *
     * @param offset  分页偏移，首次传0，后续拉取采用上一次返回的offset
     * @param limit   分页拉取数量，不建议超过100;
     * @param option  查询选项
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getConversationListByOption(long offset, int limit, V2NIMLocalConversationOption option, V2NIMSuccessCallback<V2NIMLocalConversationResult> success,
            V2NIMFailureCallback failure);

    /**
     * 获取本地会话列表，通过会话id
     *
     * @param conversationId 会话id
     * @param success        成功回调
     * @param failure        失败回调
     */
    void getConversation(@NonNull String conversationId, V2NIMSuccessCallback<V2NIMLocalConversation> success, V2NIMFailureCallback failure);

    /**
     * 根据会话id获取本地会话
     *
     * @param conversationId 会话id
     * @return 本地会话
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<V2NIMLocalConversation> getConversation(@NonNull String conversationId);

    /**
     * 根据会话id获取本地会话列表
     *
     * @param conversationIds 会话id列表
     * @param success         成功回调
     * @param failure         失败回调
     */
    void getConversationListByIds(@NonNull List<String> conversationIds, V2NIMSuccessCallback<List<V2NIMLocalConversation>> success,
            V2NIMFailureCallback failure);

    /**
     * 根据会话id获取本地会话列表
     *
     * @param conversationIds 会话id列表
     * @return 本地会话列表
     *
     * @apiNote 同步接口，存在数据库查询操作，请勿在UI线程调用
     */
    V2NIMSyncResult<List<V2NIMLocalConversation>> getConversationListByIds(@NonNull List<String> conversationIds);

    /**
     * 查询当前全量置顶的会话列表
     * 排序方式：倒序
     * @param success
     * @param failure
     */
    void getStickTopConversationList(V2NIMSuccessCallback<List<V2NIMLocalConversation>> success, V2NIMFailureCallback failure);

    /**
     * 创建本地会话
     *
     * @param conversationId 会话id
     * @param success        成功回调
     * @param failure        失败回调
     */
    void createConversation(@NonNull String conversationId, V2NIMSuccessCallback<V2NIMLocalConversation> success, V2NIMFailureCallback failure);

    /**
     * 创建本地会话(同步版本)
     * @param conversationId 会话id
     * @return 本地会话
     */
    V2NIMSyncResult<V2NIMLocalConversation> createConversation(@NonNull String conversationId);

    /**
     * 删除本地会话
     *
     * @param conversationId 会话id
     * @param clearMessage   是否删除会话消息
     * @param success        成功回调
     * @param failure        失败回调
     */
    void deleteConversation(@NonNull String conversationId, boolean clearMessage, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 删除本地会话列表
     *
     * @param conversationIds 会话id列表
     * @param clearMessage    是否删除会话消息
     * @param success         成功回调
     * @param failure         失败回调
     */
    void deleteConversationListByIds(@NonNull List<String> conversationIds, boolean clearMessage, V2NIMSuccessCallback<List<V2NIMLocalConversationOperationResult>> success,
            V2NIMFailureCallback failure);

    /**
     * 置顶会话
     *
     * @param conversationId 会话id
     * @param stickTop       是否置顶,true：置顶, false：取消置顶
     * @param success        成功回调
     * @param failure        失败回调
     */
    void stickTopConversation(@NonNull String conversationId, boolean stickTop, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 更新本地会话本地扩展字段
     *
     * @param conversationId 会话id
     * @param localExtension 本地扩展字段更新信息
     * @param success        成功回调
     * @param failure        失败回调
     */
    void updateConversationLocalExtension(@NonNull String conversationId, String localExtension, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 获取本地会话总未读数
     * @return 会话总未读数
     */
    int getTotalUnreadCount();

    /**
     * 根据会话id获取本地会话未读数
     *
     * @param conversationIds 会话id列表
     * @param success         成功回调
     * @param failure         失败回调
     */
    void getUnreadCountByIds(@NonNull List<String> conversationIds, V2NIMSuccessCallback<Integer> success, V2NIMFailureCallback failure);

    /**
     * 根据过滤条件获取相应本地会话的未读数
     *
     * @param filter  查询选项
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getUnreadCountByFilter(V2NIMLocalConversationFilter filter, V2NIMSuccessCallback<Integer> success, V2NIMFailureCallback failure);

    /**
     * 清空本地会话未读数
     *
     * @param success 成功回调
     * @param failure 失败回调
     */
    void clearTotalUnreadCount(V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 根据会话id清空本地会话未读数
     *
     * @param conversationIds 会话id列表
     * @param success         成功回调
     * @param failure         失败回调
     */
    void clearUnreadCountByIds(@NonNull List<String> conversationIds, V2NIMSuccessCallback<List<V2NIMLocalConversationOperationResult>> success, V2NIMFailureCallback failure);


    /**
     * 根据会话类型清空相应本地会话的未读数
     * @param conversationTypes
     * @param success
     * @param failure
     */
    void clearUnreadCountByTypes(@NonNull List<V2NIMConversationType> conversationTypes, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 订阅指定过滤条件的本地会话未读数
     *
     * @param filter 过滤条件
     * @return 是否订阅成功，成功返回null，失败返回V2NIMError
     */
    V2NIMError subscribeUnreadCountByFilter(@NonNull V2NIMLocalConversationFilter filter);

    /**
     * 取消订阅指定过滤条件的本地会话未读数
     *
     * @param filter 过滤条件
     * @return 是否取消订阅成功，成功返回null，失败返回V2NIMError
     */
    V2NIMError unsubscribeUnreadCountByFilter(@NonNull V2NIMLocalConversationFilter filter);

    /**
     * 获取本地会话已读时间戳
     * 当前只支持P2P，高级群， 超大群
     * @param conversationId 会话ID
     * @param success 查询成功回调
     * @param failure 查询失败回调
     */
    void getConversationReadTime(String conversationId, V2NIMSuccessCallback<Long> success, V2NIMFailureCallback failure);


    /**
     * 标记会话已读时间戳
     * 当前只支持P2P，高级群， 超大群
     * @param conversationId 会话ID
     * @param success 查询成功回调
     * @param failure 查询失败回调
     */
    void markConversationRead(String conversationId, V2NIMSuccessCallback<Long> success, V2NIMFailureCallback failure);

    /**
     * 设置当前聊天账号
     * @param conversationId 当前聊天会话id
     *                       如果为空字符串， null， 均表示不设置， 不在聊天界面
     *                       否则表示为具体的聊天界面:当前账号下， 不触发未读变更， 不触发在线通知，包括：P2P, TEAM, SUPERTEAM
     * @return 是否设置成功,失败返回V2NIMError
     */
    V2NIMSyncResult<Void> setCurrentConversation(String conversationId);

    /**
     * 添加本地会话监听
     *
     * @param listener 会话监听
     */
    void addConversationListener(@NonNull V2NIMLocalConversationListener listener);

    /**
     * 移除本地会话监听
     *
     * @param listener 会话监听
     */
    void removeConversationListener(@NonNull V2NIMLocalConversationListener listener);
}