V2NIMMessageListOption.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;

public class V2NIMMessageListOption implements Serializable {
    // 消息所属会话ID
    //myAccountID, conversationType，conversationTargetId拼装而成
    private final String conversationId;

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

    // 消息查询开始时间，闭区间
    private final long beginTime;

    // 消息查询结束时间，闭区间
    private final long endTime;

    // 每次查询条数，默认50，最大值100
    // Builder中限制了默认50
    private final int limit;

    // 锚点消息，根据锚点消息查询，不包含该消息
    private final V2NIMMessage anchorMessage;

    // 消息查询方向，如果其它参数都不填
    // 如果查询older， 则beginTime默认为long.maxValue，否则以beginTime向老查询
    // 如果查询newer， 则beginTime默认为0, 否则以beginTime开始向最新查询
    private final V2NIMMessageQueryDirection direction;

    // 严格模式
    // true：如果无法确定消息完整性，则返回错误
    // false：如果无法确定消息完整性，从数据库中查询并返回
    private final boolean strictMode;

    // 是否只查询本地消息
    private final boolean onlyQueryLocal;

    private V2NIMMessageListOption() {
        this("", null, DEFAULT_BEGIN_TIME, DEFAULT_END_TIME, DEFAULT_LIMIT, null, DEFAULT_DIRECTION, false, false);
    }

    private V2NIMMessageListOption(@NonNull String conversationId, @Nullable List<V2NIMMessageType> messageTypes, long beginTime, long endTime, int limit, @Nullable V2NIMMessage anchorMessage, @Nullable V2NIMMessageQueryDirection direction, boolean strictMode, boolean onlyQueryLocal) {
        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;
        this.strictMode = strictMode;
        this.onlyQueryLocal = onlyQueryLocal;
    }

    public String getConversationId() {
        return conversationId;
    }

    public List<V2NIMMessageType> getMessageTypes() {
        return messageTypes;
    }

    public long getBeginTime() {
        return beginTime;
    }

    public long getEndTime() {
        return endTime;
    }

    public int getLimit() {
        return limit;
    }

    public V2NIMMessage getAnchorMessage() {
        return anchorMessage;
    }

    public V2NIMMessageQueryDirection getDirection() {
        if (direction == null) {
            return DEFAULT_DIRECTION;
        } else {
            return direction;
        }
    }

    public boolean isStrictMode() {
        return strictMode;
    }

    public boolean isOnlyQueryLocal() {
        return onlyQueryLocal;
    }

    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;

    public static final class V2NIMMessageListOptionBuilder {
        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;
        private boolean strictMode;
        private boolean onlyQueryLocal;

        private V2NIMMessageListOptionBuilder(final String conversationId) {
            this.conversationId = conversationId;
        }

        public static V2NIMMessageListOptionBuilder builder(final String conversationId) {
            return new V2NIMMessageListOptionBuilder(conversationId);
        }

        public V2NIMMessageListOptionBuilder withMessageTypes(List<V2NIMMessageType> messageTypes) {
            this.messageTypes = messageTypes;
            return this;
        }

        public V2NIMMessageListOptionBuilder withBeginTime(long beginTime) {
            this.beginTime = beginTime;
            return this;
        }

        public V2NIMMessageListOptionBuilder withEndTime(long endTime) {
            this.endTime = endTime;
            return this;
        }

        public V2NIMMessageListOptionBuilder withLimit(int limit) {
            this.limit = limit;
            return this;
        }

        public V2NIMMessageListOptionBuilder withAnchorMessage(V2NIMMessage anchorMessage) {
            this.anchorMessage = anchorMessage;
            return this;
        }

        public V2NIMMessageListOptionBuilder withDirection(V2NIMMessageQueryDirection direction) {
            this.direction = direction;
            return this;
        }

        public V2NIMMessageListOptionBuilder withStrictMode(boolean strictMode) {
            this.strictMode = strictMode;
            return this;
        }

        public V2NIMMessageListOptionBuilder withOnlyQueryLocal(boolean onlyQueryLocal) {
            this.onlyQueryLocal = onlyQueryLocal;
            return this;
        }

        public V2NIMMessageListOption build() {
            return new V2NIMMessageListOption(conversationId, messageTypes, beginTime, endTime, limit, anchorMessage, direction, strictMode, onlyQueryLocal);
        }
    }
}