V2NIMTeamSearchParams.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.enums.V2NIMSearchKeywordMathType;
import com.netease.nimlib.sdk.v2.message.params.V2NIMMessageSearchExParams;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamType;
import com.netease.nimlib.util.CollectionUtil;

import java.util.Collections;
import java.util.List;

public class V2NIMTeamSearchParams {

    // 最多支持 5 个。必须设置关键字列表；
    // null 和size==0 都表示为空， 返回参数错误
    private List<String> keywordList;

    // 指定关键字列表匹配类型
    //  可设置为 “或” 关系搜索，或 “与” 关系搜索。取值分别为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR 和 V2NIM_SEARCH_KEYWORD_MATH_TYPE_AND。默认为 “或” 关系搜索。
    // 关键字列表为空或为数量为1， 该字段无效
    private V2NIMSearchKeywordMathType keywordMatchType = V2NIMSearchKeywordMathType.V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR;

    // 如果为null，或者列表为empty， 表示检索所有所有群类型
    // 否则按输入群类型进行查询
    //  只支持定义的type类型， 如果不在范围内， 返回参数错误
    private List<V2NIMTeamType> teamTypes;

    // 单次检索返回的数量。 默认20。本地可以设置INT.MAXVALUE, 返回所有检索结果
    // 必须为正数， 云端检索不建议超过100， 小于等于0， 返回参数错误
    //  该参数仅服务器有效
    private int limit = V2NIMMessageSearchExParams.LIMIT_DEFAULT;

    // 起始位置，首次传“”， 后续传上次返回的nextToken
    //  该参数仅服务器有效
    private String nextToken;

    public List<String> getKeywordList() {
        return keywordList;
    }

    public void setKeywordList(List<String> keywordList) {
        this.keywordList = keywordList;
    }

    public V2NIMSearchKeywordMathType getKeywordMatchType() {
        return keywordMatchType;
    }

    public void setKeywordMatchType(V2NIMSearchKeywordMathType keywordMatchType) {
        this.keywordMatchType = keywordMatchType;
    }

    public List<V2NIMTeamType> getTeamTypes() {
        return teamTypes;
    }

    public void setTeamTypes(List<V2NIMTeamType> teamTypes) {
        this.teamTypes = teamTypes;
    }

    public int getLimit() {
        return limit;
    }

    public void setLimit(int limit) {
        this.limit = limit;
    }

    public String getNextToken() {
        return nextToken;
    }

    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }

    /**
     * 验证参数有效性
     *
     * @return true表示参数有效，false表示参数无效
     */
    public String isValidWithErrorMsg() {
        if (keywordMatchType == null) {
            return "keywordMatchType is null";
        }

        if (!CollectionUtil.isEmpty(teamTypes)) {
            for (V2NIMTeamType teamType : teamTypes) {
                if (teamType == null) {
                    return "teamType is null: " + CollectionUtil.toStringSafe(teamTypes);
                }
            }
        }

        // 关键字列表不能为空
        if (keywordList == null || keywordList.isEmpty()) {
            return "keywordList is null or empty";
        }

        // 关键字列表最多5个
        if (keywordList.size() > 5) {
            return "keywordList size > 5";
        }

        return null;
    }
}