V2NIMCloudMessageListOption.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.message.option;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.netease.nimlib.sdk.v2.message.V2NIMMessage;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageQueryDirection;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageType;
import java.io.Serializable;
import java.util.List;

/**
 * 云端消息查询相关参数
 * <p>
 * 该类用于设置云端消息查询的各种参数，包括会话ID、消息类型、时间范围、查询条数、锚点消息和查询方向等。
 * 通过使用内部的Builder类，可以方便地构建查询选项。
 */
public class V2NIMCloudMessageListOption implements Serializable {

    /**
     * 消息所属会话ID
     */
    private final String                 conversationId;
    /**
     * 根据消息类型查询会话， 为null或空列表， 则表示查询所有消息类型
     */
    private final List<V2NIMMessageType> messageTypes;

    /**
     * 消息查询开始时间，小于等于 endTime
     * 默认从0开始查询,闭区间
     */
    private final long beginTime;

    /**
     * 消息查询结束时间
     * 默认当前时间，闭区间
     */
    private final long endTime;

    /**
     * 每次查询条数，默认50，最大值100
     */
    private final int limit;

    /**
     * 锚点消息，根据锚点消息查询，不包含该消息
     * 如果anchor为空， 则以beginTime， endTime为查询范围， 闭区间
     */
    private final V2NIMMessage anchorMessage;

    /**
     * 消息查询方向，如果其它参数都不填
     * DESC:  按时间从大到小查询
     * ASC:按时间从小到大查询
     */
    private final V2NIMMessageQueryDirection direction;

    /**
     * 私有构造函数，使用默认值初始化
     */
    private V2NIMCloudMessageListOption() {
        this("", null, DEFAULT_BEGIN_TIME, DEFAULT_END_TIME, DEFAULT_LIMIT, null, DEFAULT_DIRECTION);
    }

    /**
     * 私有构造函数，用于创建V2NIMCloudMessageListOption实例
     *
     * @param conversationId 会话ID
     * @param messageTypes   消息类型列表
     * @param beginTime      开始时间
     * @param endTime        结束时间
     * @param limit          查询条数限制
     * @param anchorMessage  锚点消息
     * @param direction      查询方向
     */
    private V2NIMCloudMessageListOption(@NonNull String conversationId, @Nullable List<V2NIMMessageType> messageTypes, long beginTime, long endTime,
            int limit, @Nullable V2NIMMessage anchorMessage, @Nullable V2NIMMessageQueryDirection direction) {
        this.conversationId = conversationId;
        this.messageTypes = messageTypes;
        this.beginTime = beginTime;
        this.endTime = endTime;
        this.limit = limit;
        this.anchorMessage = anchorMessage;
        this.direction = direction == null ? DEFAULT_DIRECTION : direction;
    }


    /**
     * 获取会话ID
     *
     * @return 会话ID
     */
    public String getConversationId() {
        return conversationId;
    }

    /**
     * 获取消息类型列表
     *
     * @return 消息类型列表
     */
    public List<V2NIMMessageType> getMessageTypes() {
        return messageTypes;
    }

    /**
     * 获取查询开始时间
     *
     * @return 查询开始时间
     */
    public long getBeginTime() {
        return beginTime;
    }

    /**
     * 获取查询结束时间
     *
     * @return 查询结束时间
     */
    public long getEndTime() {
        return endTime;
    }

    /**
     * 获取查询条数限制
     *
     * @return 查询条数限制
     */
    public int getLimit() {
        return limit;
    }

    /**
     * 获取锚点消息
     *
     * @return 锚点消息
     */
    public V2NIMMessage getAnchorMessage() {
        return anchorMessage;
    }

    /**
     * 获取查询方向
     *
     * @return 查询方向，如果为null则返回默认方向
     */
    public V2NIMMessageQueryDirection getDirection() {
        if (direction == null) {
            return DEFAULT_DIRECTION;
        }
        else {
            return direction;
        }
    }

    /**
     * 默认开始时间
     */
    private static final long                       DEFAULT_BEGIN_TIME = 0;
    /**
     * 默认结束时间
     */
    private static final long                       DEFAULT_END_TIME   = 0;
    /**
     * 默认查询条数限制
     */
    private static final int                        DEFAULT_LIMIT      = 50;
    /**
     * 默认查询方向
     */
    private static final V2NIMMessageQueryDirection DEFAULT_DIRECTION  = V2NIMMessageQueryDirection.V2NIM_QUERY_DIRECTION_DESC;

    /**
     * V2NIMCloudMessageListOption的构建器类
     */
    public static final class V2NIMCloudMessageListOptionBuilder {

        private final String                     conversationId;
        private       List<V2NIMMessageType>     messageTypes;
        private       long                       beginTime = DEFAULT_BEGIN_TIME;
        private       long                       endTime   = DEFAULT_END_TIME;
        private       int                        limit     = DEFAULT_LIMIT;
        private       V2NIMMessage               anchorMessage;
        private       V2NIMMessageQueryDirection direction;

        /**
         * 私有构造函数
         *
         * @param conversationId 会话ID
         */
        private V2NIMCloudMessageListOptionBuilder(final String conversationId) {
            this.conversationId = conversationId;
        }

        /**
         * 创建构建器实例
         *
         * @param conversationId 会话ID
         *
         * @return V2NIMCloudMessageListOptionBuilder实例
         */
        public static V2NIMCloudMessageListOptionBuilder builder(final String conversationId) {
            return new V2NIMCloudMessageListOptionBuilder(conversationId);
        }

        /**
         * 设置消息类型列表
         *
         * @param messageTypes 消息类型列表
         *
         * @return 构建器实例
         */
        public V2NIMCloudMessageListOptionBuilder withMessageTypes(List<V2NIMMessageType> messageTypes) {
            this.messageTypes = messageTypes;
            return this;
        }

        /**
         * 设置查询开始时间
         *
         * @param beginTime 查询开始时间
         *
         * @return 构建器实例
         */
        public V2NIMCloudMessageListOptionBuilder withBeginTime(long beginTime) {
            this.beginTime = beginTime;
            return this;
        }

        /**
         * 设置查询结束时间
         *
         * @param endTime 查询结束时间
         *
         * @return 构建器实例
         */
        public V2NIMCloudMessageListOptionBuilder withEndTime(long endTime) {
            this.endTime = endTime;
            return this;
        }

        /**
         * 设置查询条数限制
         *
         * @param limit 查询条数限制
         *
         * @return 构建器实例
         */
        public V2NIMCloudMessageListOptionBuilder withLimit(int limit) {
            this.limit = limit;
            return this;
        }

        /**
         * 设置锚点消息
         *
         * @param anchorMessage 锚点消息
         *
         * @return 构建器实例
         */
        public V2NIMCloudMessageListOptionBuilder withAnchorMessage(V2NIMMessage anchorMessage) {
            this.anchorMessage = anchorMessage;
            return this;
        }

        /**
         * 设置查询方向
         *
         * @param direction 查询方向
         *
         * @return 构建器实例
         */
        public V2NIMCloudMessageListOptionBuilder withDirection(V2NIMMessageQueryDirection direction) {
            this.direction = direction;
            return this;
        }

        /**
         * 构建V2NIMCloudMessageListOption实例
         *
         * @return V2NIMCloudMessageListOption实例
         */
        public V2NIMCloudMessageListOption build() {
            return new V2NIMCloudMessageListOption(conversationId, messageTypes, beginTime, endTime, limit, anchorMessage, direction);
        }
    }
}