V2NIMTopicMessageListOption.java

浏览该文件的文档.

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

import android.text.TextUtils;
import com.netease.nimlib.sdk.v2.message.V2NIMMessage;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMQueryDirection;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMSortOrder;
import com.netease.nimlib.sdk.v2.topic.V2NIMTopic;
import com.netease.nimlib.util.StringUtil;

/**
 * Topic 消息列表查询参数。
 *
 * <p>用于查询某个 Topic 下的消息列表。</p>
 */
public class V2NIMTopicMessageListOption {
    private static final int MAX_LIMIT = 100;

    /**
     * 查询目标 Topic。
     */
    private final V2NIMTopic topic;
    /**
     * 查询起始时间，单位毫秒。
     */
    private final long beginTime;
    /**
     * 查询结束时间，单位毫秒，0 表示不限制。
     */
    private final long endTime;
    /**
     * 锚点消息；传入后查询结果不包含该消息。
     */
    private final V2NIMMessage anchorMessage;
    /**
     * 单次查询上限。
     *
     * <p>取值范围为 1 到 100。</p>
     */
    private final int limit;
    /**
     * 查询方向，传空时默认为倒序方向。
     */
    private final V2NIMQueryDirection direction;
    /**
     * 结果排序方式，传空时默认升序。
     */
    private final V2NIMSortOrder sortOrder;

    /**
     * 构造 Topic 消息列表查询参数。
     *
     * @param topic 查询目标 Topic
     * @param beginTime 查询起始时间，单位毫秒
     * @param endTime 查询结束时间，单位毫秒，0 表示不限制
     * @param anchorMessage 锚点消息，查询结果不包含该消息
     * @param limit 单次查询上限，取值范围为 1 到 100
     * @param direction 查询方向，传空时默认 {@link V2NIMQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     * @param sortOrder 结果排序方式，传空时默认 {@link V2NIMSortOrder#V2NIM_SORT_ORDER_ASC}
     */
    public V2NIMTopicMessageListOption(V2NIMTopic topic, long beginTime, long endTime, V2NIMMessage anchorMessage, int limit,
        V2NIMQueryDirection direction, V2NIMSortOrder sortOrder) {
        this.topic = topic;
        this.beginTime = beginTime;
        this.endTime = endTime;
        this.anchorMessage = anchorMessage;
        this.limit = limit;
        this.direction = direction == null ? V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC : direction;
        this.sortOrder = sortOrder == null ? V2NIMSortOrder.V2NIM_SORT_ORDER_ASC : sortOrder;
    }

    /**
     * 返回查询目标 Topic。
     *
     * @return 查询目标 Topic
     */
    public V2NIMTopic getTopic() {
        return topic;
    }

    /**
     * 返回起始时间。
     *
     * @return 起始时间，单位毫秒
     */
    public long getBeginTime() {
        return beginTime;
    }

    /**
     * 返回结束时间。
     *
     * @return 结束时间，单位毫秒
     */
    public long getEndTime() {
        return endTime;
    }

    /**
     * 返回锚点消息。
     *
     * @return 锚点消息
     */
    public V2NIMMessage getAnchorMessage() {
        return anchorMessage;
    }

    /**
     * 返回查询上限。
     *
     * @return 单次查询上限，取值范围为 1 到 100
     */
    public int getLimit() {
        return limit;
    }

    /**
     * 返回查询方向。
     *
     * @return 查询方向
     */
    public V2NIMQueryDirection getDirection() {
        return direction;
    }

    /**
     * 返回结果排序。
     *
     * @return 结果排序方式
     */
    public V2NIMSortOrder getSortOrder() {
        return sortOrder;
    }

    /**
     * 返回参数非法原因。
     *
     * @return 参数合法时返回 `null`，否则返回具体错误原因
     */
    public String isValidWithErrorMsg() {
        if (topic == null) {
            return "topic is null";
        }
        if (TextUtils.isEmpty(topic.getConversationId())) {
            return "topic conversationId is empty";
        }
        if (topic.getTopicId() <= 0) {
            return "topicId must be greater than 0";
        }
        if (topic.getCreateTime() <= 0) {
            return "topic createTime must be greater than 0";
        }
        if (TextUtils.isEmpty(topic.getMessageClientId())) {
            return "topic messageClientId is empty";
        }
        if (StringUtil.parseLong(topic.getMessageServerId(), 0L) <= 0) {
            return "topic messageServerId must be greater than 0";
        }
        if (topic.getMessageTime() <= 0) {
            return "topic messageTime must be greater than 0";
        }
        if (limit <= 0) {
            return "limit must be greater than 0";
        }
        if (limit > MAX_LIMIT) {
            return "limit must be less than or equal to 100";
        }
        if (beginTime < 0) {
            return "beginTime must be greater than or equal to 0";
        }
        if (endTime < 0) {
            return "endTime must be greater than or equal to 0";
        }
        if (endTime != 0 && beginTime > endTime) {
            return "beginTime must be less than or equal to endTime";
        }
        if (anchorMessage == null) {
            return null;
        }
        long anchorTime = anchorMessage.getCreateTime();
        if (anchorTime < beginTime) {
            return "anchorMessage createTime must be greater than or equal to beginTime";
        }
        if (endTime != 0 && anchorTime > endTime) {
            return "anchorMessage createTime must be less than or equal to endTime";
        }
        return null;
    }

    /**
     * 参数是否合法。
     *
     * @return `true` 表示参数合法，否则为 `false`
     */
    public boolean isValid() {
        return isValidWithErrorMsg() == null;
    }
}