V2NIMTeamMemberSearchOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.enums.V2NIMSortOrder;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamType;

/**
 * 群成员搜索选项类
 * 用于设置群成员搜索的各种参数
 * 当前只检索群昵称，不连表查询
 */
public class V2NIMTeamMemberSearchOption {

    /**
     * 搜索关键词，不为空
     */
    private final String keyword;

    /**
     * 群组类型
     */
    private final V2NIMTeamType teamType;

    /**
     * 群组ID
     * 如果不传则检索所有群，如果需要检索特定的群，则需要同时传入teamId+teamType
     */
    private final String teamId;

    /**
     * 起始位置
     * 首次传""， 后续传上次返回的nextToken
     */
    private final String nextToken;

    /**
     * 排序方式
     * V2NIM_SORT_ORDER_DESC：按joinTime降序
     * V2NIM_SORT_ORDER_ASC：按joinTime升序
     */
    private final V2NIMSortOrder order;

    /**
     * 查询成员的个数
     * 默认10
     * 必须为正数
     */
    private final int limit;
    /**
     * 是否搜索用户账号
     * 默认为false， 使用前提是 accountId带有业务属性，否则不建议开启此参数
     */
    private final boolean searchAccountId;

    /**
     * 无参构造方法
     * Hawk需要无参构造方法
     */
    private V2NIMTeamMemberSearchOption() {
        this(null, null, null, TEAM_MEMBER_SEARCH_OPTION_PAGETOKEN_DEFAULT, TEAM_MEMBER_SEARCH_OPTION_ORDER_DEFAULT,
                TEAM_MEMBER_SEARCH_OPTION_LIMIT_DEFAULT,TEAM_MEMBER_SEARCH_OPTION_SEARCH_ACCOUNT_ID);
    }

    /**
     * 全参数构造方法
     *
     * @param keyword         搜索关键词
     * @param teamType        群组类型
     * @param teamId          群组ID
     * @param nextToken       起始位置
     * @param order           排序方式
     * @param limit           查询成员的个数
     * @param searchAccountId 是否搜索用户账号
     */
    private V2NIMTeamMemberSearchOption(String keyword, V2NIMTeamType teamType, String teamId, String nextToken, V2NIMSortOrder order, int limit,boolean searchAccountId) {
        this.keyword = keyword;
        this.teamType = teamType;
        this.teamId = teamId;
        this.nextToken = nextToken;
        this.order = order;
        this.limit = limit;
        this.searchAccountId = searchAccountId;
    }

    /**
     * 获取搜索关键词
     *
     * @return 搜索关键词
     */
    public String getKeyword() {
        return keyword;
    }

    /**
     * 获取群组类型
     *
     * @return 群组类型
     */
    public V2NIMTeamType getTeamType() {
        return teamType;
    }

    /**
     * 获取群组ID
     *
     * @return 群组ID
     */
    public String getTeamId() {
        return teamId;
    }

    /**
     * 获取起始位置
     *
     * @return 起始位置
     */
    public String getNextToken() {
        return nextToken;
    }

    /**
     * 获取排序方式
     *
     * @return 排序方式
     */
    public V2NIMSortOrder getOrder() {
        return order;
    }

    /**
     * 获取查询成员的个数
     *
     * @return 查询成员的个数
     */
    public int getLimit() {
        return limit;
    }

    /**
     * 获取是否搜索用户账号
     *
     * @return 是否搜索用户账号
     */
    public boolean isSearchAccountId() {
        return searchAccountId;
    }

    @Override
    public String toString() {
        return "V2NIMTeamMemberSearchOption{" + "keyword='" + keyword + '\'' + ", teamType=" + teamType + ", teamId='" + teamId + '\'' + ", nextToken='"
                + nextToken + '\'' + ", order=" + order + ", limit=" + limit +", searchAccountId=" + searchAccountId + '}';
    }

    /**
     * 默认排序方式：降序
     */
    private static final V2NIMSortOrder TEAM_MEMBER_SEARCH_OPTION_ORDER_DEFAULT = V2NIMSortOrder.V2NIM_SORT_ORDER_DESC;

    /**
     * 默认查询成员的个数：10
     */
    private static final int TEAM_MEMBER_SEARCH_OPTION_LIMIT_DEFAULT = 10;

    /**
     * 默认起始位置：空字符串
     */
    private static final String TEAM_MEMBER_SEARCH_OPTION_PAGETOKEN_DEFAULT = "";

    private static final boolean TEAM_MEMBER_SEARCH_OPTION_SEARCH_ACCOUNT_ID = false;

    /**
     * V2NIMTeamMemberSearchOption的构建器类
     */
    public static final class V2NIMTeamMemberSearchOptionBuilder {

        private final String         keyword;
        private final V2NIMTeamType  teamType;
        private       String         teamId;
        private final String         nextToken;
        private       V2NIMSortOrder order = TEAM_MEMBER_SEARCH_OPTION_ORDER_DEFAULT;
        private       int            limit = TEAM_MEMBER_SEARCH_OPTION_LIMIT_DEFAULT;
        private       boolean        searchAccountId = TEAM_MEMBER_SEARCH_OPTION_SEARCH_ACCOUNT_ID;

        /**
         * 构造方法
         *
         * @param keyword   搜索关键词
         * @param teamType  群组类型
         * @param nextToken 起始位置
         */
        public V2NIMTeamMemberSearchOptionBuilder(String keyword, V2NIMTeamType teamType, String nextToken) {
            this.keyword = keyword;
            this.teamType = teamType;
            this.nextToken = nextToken;
        }

        /**
         * 复制构造方法
         *
         * @param other 另一个V2NIMTeamMemberSearchOption对象
         */
        public V2NIMTeamMemberSearchOptionBuilder(V2NIMTeamMemberSearchOption other) {
            this.keyword = other.keyword;
            this.teamType = other.teamType;
            this.teamId = other.teamId;
            this.nextToken = other.nextToken;
            this.order = other.order;
            this.limit = other.limit;
        }

        /**
         * 创建构建器
         *
         * @param keyword   搜索关键词
         * @param teamType  群组类型
         * @param nextToken 起始位置
         *
         * @return V2NIMTeamMemberSearchOptionBuilder对象
         */
        public static V2NIMTeamMemberSearchOptionBuilder builder(String keyword, V2NIMTeamType teamType, String nextToken) {
            return new V2NIMTeamMemberSearchOptionBuilder(keyword, teamType, nextToken);
        }

        /**
         * 设置群组ID
         *
         * @param teamId 群组ID
         *
         * @return 当前构建器对象
         */
        public V2NIMTeamMemberSearchOptionBuilder withTeamId(String teamId) {
            this.teamId = teamId;
            return this;
        }

        /**
         * 设置排序方式
         *
         * @param order 排序方式
         *
         * @return 当前构建器对象
         */
        public V2NIMTeamMemberSearchOptionBuilder withOrder(V2NIMSortOrder order) {
            this.order = order;
            return this;
        }

        /**
         * 设置查询成员的个数
         *
         * @param limit 查询成员的个数
         *
         * @return 当前构建器对象
         */
        public V2NIMTeamMemberSearchOptionBuilder withLimit(int limit) {
            this.limit = limit;
            return this;
        }

        /**
         * 设置是否搜索用户账号
         *
         * @param searchAccountId 是否搜索用户账号
         *
         * @return 当前构建器对象
         */
        public V2NIMTeamMemberSearchOptionBuilder withSearchAccountId(boolean searchAccountId) {
            this.searchAccountId = searchAccountId;
            return this;
        }

        /**
         * 构建V2NIMTeamMemberSearchOption对象
         *
         * @return V2NIMTeamMemberSearchOption对象
         */
        public V2NIMTeamMemberSearchOption build() {
            return new V2NIMTeamMemberSearchOption(keyword, teamType, teamId, nextToken, order, limit,searchAccountId);
        }
    }
}