QChatGetChannelCategoriesByPageParam.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;
import com.netease.nimlib.sdk.qchat.enums.QChatChannelCategorySearchSortEnum;

/**
 * "分页查询服务器下频道类别列表"接口入参
 */
public class QChatGetChannelCategoriesByPageParam {

    /**
     * 服务器Id
     */
    @NonNull
    private final Long serverId;
    /**
     * 查询锚点时间戳
     */
    @NonNull
    private final Long timeTag;
    /**
     * 查询数量限制
     */
    private Integer limit;
    /**
     * 查询排序类型
     */
    private QChatChannelCategorySearchSortEnum sortType = QChatChannelCategorySearchSortEnum.CreateTime;
    /**
     * 分页标记
     * 第一页不传
     * 翻下一页传接口返回的cursor
     */
    private String  cursor;

    private QChatGetChannelCategoriesByPageParam() {
        this(0, 0);
    }

    /**
     *
     * @param serverId 服务器Id
     * @param timeTag 查询锚点时间戳,传0取当前时间戳
     */
    public QChatGetChannelCategoriesByPageParam(long serverId, long timeTag) {
        this.serverId = serverId;
        this.timeTag = timeTag;
    }

    /**
     *
     * @param serverId 服务器Id
     * @param timeTag 查询锚点时间戳,传0取当前时间戳
     * @param limit 查询数量限制,默认100
     * @param sortType 查询排序类型,默认CreateTime
     * @param cursor 分页标记,第一页不传,翻下一页传接口返回的cursor
     */
    public QChatGetChannelCategoriesByPageParam(long serverId, long timeTag, Integer limit, QChatChannelCategorySearchSortEnum sortType, String cursor) {
        this.serverId = serverId;
        this.timeTag = timeTag;
        this.limit = limit;
        this.sortType = sortType;
        this.cursor = cursor;
    }



    /**
     * 获取服务器id
     * @return
     */
    @NonNull
    public Long getServerId() {
        return serverId;
    }

    /**
     * 获取查询时间戳
     * @return
     */
    @NonNull
    public Long getTimeTag() {
        return timeTag;
    }

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

    /**
     * 设置查询数量限制，默认100
     * @param limit
     */
    public void setLimit(Integer limit) {
        this.limit = limit;
    }

    /**
     * 获取排序类型
     * @return 排序类型
     */
    public QChatChannelCategorySearchSortEnum getSortType() {
        return sortType;
    }

    /**
     * 设置排序类型
     * @param sortType 排序类型
     */
    public void setSortType(QChatChannelCategorySearchSortEnum sortType) {
        this.sortType = sortType;
    }

    /**
     * 获取分页标记
     * @return 分页标记
     */
    public String getCursor() {
        return cursor;
    }

    /**
     * 设置分页标记
     * @param cursor 分页标记
     */
    public void setCursor(String cursor) {
        this.cursor = cursor;
    }

    /**
     * QChatGetChannelCategoriesByPageParam 构造器
     */
    public static class Builder {
        private Long serverId;
        private Long timeTag;
        private Integer limit;
        private QChatChannelCategorySearchSortEnum sortType = QChatChannelCategorySearchSortEnum.CreateTime;
        private String  cursor;

        /**
         * 设置服务器id
         * @param serverId 服务器id
         * @return Builder
         */
        public Builder serverId(long serverId) {
            this.serverId = serverId;
            return this;
        }

        /**
         * 设置查询锚点时间戳
         * @param timeTag 查询锚点时间戳,传0取当前时间戳
         * @return Builder
         */
        public Builder timeTag(long timeTag) {
            this.timeTag = timeTag;
            return this;
        }

        /**
         * 设置查询数量限制
         * @param limit 查询数量限制,默认100
         * @return Builder
         */
        public Builder limit(int limit) {
            this.limit = limit;
            return this;
        }

        /**
         * 设置查询排序类型
         * @param sortType 查询排序类型,默认CreateTime
         * @return Builder
         */
        public Builder sortType(QChatChannelCategorySearchSortEnum sortType) {
            this.sortType = sortType;
            return this;
        }

        /**
         * 设置分页标记
         * @param cursor 分页标记,第一页不传,翻下一页传接口返回的cursor
         * @return Builder
         */
        public Builder cursor(String cursor) {
            this.cursor = cursor;
            return this;
        }

        /**
         * 构建QChatGetChannelCategoriesByPageParam
         * @return QChatGetChannelCategoriesByPageParam
         */
        public QChatGetChannelCategoriesByPageParam build() {
            return new QChatGetChannelCategoriesByPageParam(serverId, timeTag, limit, sortType, cursor);
        }
    }
}