V2NIMTopicListOption.java

浏览该文件的文档.

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

import android.text.TextUtils;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMQueryDirection;

/**
 * Topic 列表查询参数。
 *
 * <p>用于按会话、时间范围和方向分页查询 Topic 列表。</p>
 */
public class V2NIMTopicListOption {
    /**
     * 单次查询上限最大值。
     */
    public static final int MAX_LIMIT = 100;
    /**
     * 目标会话 ID。
     */
    private final String conversationId;
    /**
     * 查询起始时间，单位毫秒。
     */
    private final long beginTime;
    /**
     * 查询结束时间，单位毫秒，0 表示不限制。
     */
    private final long endTime;
    /**
     * 分页 token，首次查询可传空。
     */
    private final String nextToken;
    /**
     * 单次查询上限。
     */
    private final int limit;
    /**
     * 查询方向，传空时默认为倒序方向。
     */
    private final V2NIMQueryDirection direction;

    /**
     * 构造 Topic 列表查询参数。
     *
     * @param conversationId 会话 ID
     * @param beginTime 查询起始时间，单位毫秒
     * @param endTime 查询结束时间，单位毫秒，0 表示不限制
     * @param nextToken 分页 token
     * @param limit 单次查询上限
     * @param direction 查询方向，传空时默认 {@link V2NIMQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     */
    public V2NIMTopicListOption(String conversationId, long beginTime, long endTime, String nextToken, int limit, V2NIMQueryDirection direction) {
        this.conversationId = conversationId;
        this.beginTime = beginTime;
        this.endTime = endTime;
        this.nextToken = nextToken;
        this.limit = limit;
        this.direction = direction == null ? V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC : direction;
    }

    /**
     * 返回会话 ID。
     *
     * @return 会话 ID
     */
    public String getConversationId() {
        return conversationId;
    }

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

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

    /**
     * 返回分页 token。
     *
     * @return 分页 token
     */
    public String getNextToken() {
        return nextToken;
    }

    /**
     * 返回查询上限。
     *
     * @return 单次查询上限
     */
    public int getLimit() {
        return limit;
    }

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

    /**
     * 返回参数非法原因。
     *
     * @return 参数合法时返回 `null`，否则返回具体错误原因
     */
    public String isValidWithErrorMsg() {
        if (TextUtils.isEmpty(conversationId)) {
            return "conversationId is empty";
        }
        if (limit <= 0) {
            return "limit must be greater than 0";
        }
        if (limit > MAX_LIMIT) {
            return "limit must be less than or equal to " + MAX_LIMIT;
        }
        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";
        }
        return null;
    }

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