QChatSearchChannelByPageParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat.param;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.netease.nimlib.sdk.qchat.enums.QChatChannelSearchSortEnum;
import com.netease.nimlib.util.StringUtil;

/**
 * 检索频道的接口入参
 */
public class QChatSearchChannelByPageParam {

    /**
     * 检索关键字，目标检索服务器名称
     */
    @NonNull
    private final String keyword;

    /**
     * 排序规则 true：正序；false：反序
     */
    private final boolean asc;

    /**
     * 查询时间范围的开始时间
     */
    @Nullable
    private Long startTime;

    /**
     * 查询时间范围的结束时间，要求比开始时间大
     */
    @Nullable
    private Long endTime;

    /**
     * 检索返回的最大记录数，最大和默认都是100
     */
    @Nullable
    private Integer limit;

    /**
     * 服务器类型
     */
    @Nullable
    private Long serverId;

    /**
     * 排序条件
     */
    private QChatChannelSearchSortEnum sort;

    /**
     * 查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     */
    private String cursor;

    /**
     * 构造函数
     *
     * @param keyword 检索关键字，目标检索服务器名称
     * @param asc 排序规则 true：正序；false：反序
     */
    public QChatSearchChannelByPageParam(@NonNull String keyword, boolean asc) {
        this(keyword, asc, null, null, null, null);
    }

    /**
     * 构造函数
     *
     * @param keyword 检索关键字，目标检索服务器名称
     * @param asc 排序规则 true：正序；false：反序
     * @param startTime 查询时间范围的开始时间
     * @param endTime 查询时间范围的结束时间，要求比开始时间大
     * @param limit 检索返回的最大记录数，最大和默认都是100
     * @param serverId 服务器类型
     */
    public QChatSearchChannelByPageParam(@NonNull String keyword, boolean asc, @Nullable Long startTime, @Nullable Long endTime,
                                         @Nullable Integer limit, @Nullable Long serverId) {
        this.keyword = keyword;
        this.asc = asc;
        this.startTime = startTime;
        this.endTime = endTime;
        this.limit = limit;
        this.serverId = serverId;
    }

    /**
     * 构造函数
     *
     * @param keyword 检索关键字，目标检索服务器名称
     * @param asc 排序规则 true：正序；false：反序
     * @param startTime 查询时间范围的开始时间
     * @param endTime 查询时间范围的结束时间，要求比开始时间大
     * @param limit 检索返回的最大记录数，最大和默认都是100
     * @param serverId 服务器类型
     * @param cursor 查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     */
    public QChatSearchChannelByPageParam(@NonNull String keyword, boolean asc, @Nullable Long startTime, @Nullable Long endTime,
            @Nullable Integer limit, @Nullable Long serverId,@Nullable String cursor) {
        this.keyword = keyword;
        this.asc = asc;
        this.startTime = startTime;
        this.endTime = endTime;
        this.limit = limit;
        this.serverId = serverId;
        this.cursor = cursor;
    }
    /**
     * 构造函数
     *
     * @param keyword 检索关键字，目标检索服务器名称
     * @param asc 排序规则 true：正序；false：反序
     * @param startTime 查询时间范围的开始时间
     * @param endTime 查询时间范围的结束时间，要求比开始时间大
     * @param limit 检索返回的最大记录数，最大和默认都是100
     * @param serverId 服务器类型
     * @param sort 排序条件 {@link QChatChannelSearchSortEnum}
     * @param cursor 查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     */
    public QChatSearchChannelByPageParam(@NonNull String keyword, boolean asc, @Nullable Long startTime, @Nullable Long endTime,
            @Nullable Integer limit, @Nullable Long serverId, QChatChannelSearchSortEnum sort,@Nullable String cursor) {
        this.keyword = keyword;
        this.asc = asc;
        this.startTime = startTime;
        this.endTime = endTime;
        this.limit = limit;
        this.serverId = serverId;
        this.sort = sort;
        this.cursor = cursor;
    }

    /**
     * 获取检索关键字
     */
    public String getKeyword() {
        return keyword;
    }

    /**
     * 是否是正序
     */
    public boolean isAsc() {
        return asc;
    }

    /**
     * 获取查询时间范围的开始时间
     */
    @Nullable
    public Long getStartTime() {
        return startTime;
    }

    /**
     * 设置查询时间范围的开始时间
     * @param startTime 查询时间范围的开始时间
     */
    public void setStartTime(@Nullable Long startTime) {
        this.startTime = startTime;
    }

    /**
     * 获取查询时间范围的结束时间
     */
    @Nullable
    public Long getEndTime() {
        return endTime;
    }

    /**
     * 设置查询时间范围的结束时间
     * @param endTime 查询时间范围的结束时间
     */
    public void setEndTime(@Nullable Long endTime) {
        this.endTime = endTime;
    }

    /**
     * 获取检索返回的最大记录数
     */
    @Nullable
    public Integer getLimit() {
        return limit;
    }

    /**
     * 设置检索返回的最大记录数
     * @param limit 检索返回的最大记录数
     */
    public void setLimit(@Nullable Integer limit) {
        this.limit = limit;
    }

    /**
     * 获取服务器类型
     */
    @Nullable
    public Long getServerId() {
        return serverId;
    }

    /**
     * 设置服务器类型
     * @param serverId 服务器类型
     */
    public void setServerId(@Nullable Long serverId) {
        this.serverId = serverId;
    }

    /**
     * 获取排序条件
     * @return
     */
    public QChatChannelSearchSortEnum getSort() {
        return sort;
    }

    /**
     * 设置排序条件
     * @param sort
     */
    public void setSort(QChatChannelSearchSortEnum sort) {
        this.sort = sort;
    }

    /**
     * 获取查询游标
     * @return
     */
    public String getCursor() {
        return cursor;
    }

    /**
     * 设置查询游标，下次查询的起始位置,第一页设置为null，查询下一页是传入上一页返回的cursor
     * @param cursor
     */
    public void setCursor(String cursor) {
        this.cursor = cursor;
    }

    /**
     * 是否合法
     */
    public boolean isValid() {
        if (StringUtil.isEmpty(keyword)) {
            return false;
        }
        if (startTime != null && startTime < 0) {
            return false;
        }
        if (endTime != null && endTime < 0) {
            return false;
        }
        if (limit != null && limit < 0) {
            return false;
        }
        if (serverId != null && serverId <= 0) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "QChatSearchChannelByPageParam{" +
                "keyword='" + keyword + '\'' +
                ", asc=" + asc +
                ", startTime=" + startTime +
                ", endTime=" + endTime +
                ", limit=" + limit +
                ", serverId=" + serverId +
                '}';
    }
}