V2NIMTeamMemberQueryOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.enums.V2NIMQueryDirection;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamMemberRoleQueryType;

/**
 * 群组成员查询参数
 */
public class V2NIMTeamMemberQueryOption {

    /**
     * 群组成员角色查询类型
     */
    private V2NIMTeamMemberRoleQueryType roleQueryType;
    /**
     * 是否只返回聊天禁言成员列表
     * true： 只返回聊天禁言成员列表
     * false：全部成员列表
     */
    private Boolean                      onlyChatBanned = false;
    /**
     * 消息查询方向
     */
    private V2NIMQueryDirection direction = V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC;
    /**
     * 分页偏移，首次传""，后续拉取采用上一次返回的nextToken
     */
    private String              nextToken = "";
    /**
     * 分页拉取数量
     */
    private Integer                 limit;

    public V2NIMTeamMemberQueryOption() {
    }

    /**
     *
     * @param roleQueryType 群组成员角色查询类型
     * @param onlyChatBanned 是否只返回聊天禁言成员列表
     * @param nextToken 分页偏移，首次传""，后续拉取采用上一次返回的nextToken
     * @param limit 分页拉取数量
     */
    public V2NIMTeamMemberQueryOption(V2NIMTeamMemberRoleQueryType roleQueryType, boolean onlyChatBanned,V2NIMQueryDirection direction, String nextToken, int limit) {
        this.roleQueryType = roleQueryType;
        this.onlyChatBanned = onlyChatBanned;
        this.direction = direction;
        this.nextToken = nextToken;
        this.limit = limit;
    }

    /**
     * 获取群组成员角色查询类型
     * @return 群组成员角色查询类型
     */
    public V2NIMTeamMemberRoleQueryType getRoleQueryType() {
        return roleQueryType;
    }

    /**
     * 设置群组成员角色查询类型
     * @param roleQueryType 群组成员角色查询类型
     */
    public void setRoleQueryType(V2NIMTeamMemberRoleQueryType roleQueryType) {
        this.roleQueryType = roleQueryType;
    }

    /**
     * 是否只返回聊天禁言成员列表
     * @return 是否只返回聊天禁言成员列表
     */
    public Boolean isOnlyChatBanned() {
        return onlyChatBanned;
    }

    /**
     * 设置是否只返回聊天禁言成员列表，true： 只返回聊天禁言成员列表，false：全部成员列表
     * @param onlyChatBanned 是否只返回聊天禁言成员列表
     */
    public void setOnlyChatBanned(boolean onlyChatBanned) {
        this.onlyChatBanned = onlyChatBanned;
    }

    public V2NIMQueryDirection getDirection() {
        return direction;
    }

    public void setDirection(V2NIMQueryDirection direction) {
        this.direction = direction;
    }

    /**
     * 获取分页偏移
     * @return 分页偏移
     */
    public String getNextToken() {
        return nextToken;
    }

    /**
     * 设置分页偏移，首次传""，后续拉取采用上一次返回的nextToken
     * @param nextToken 分页偏移
     */
    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }

    /**
     * 获取分页拉取数量
     * @return 分页拉取数量
     */
    public Integer getLimit() {
        return limit;
    }

    /**
     * 设置分页拉取数量
     * @param limit 分页拉取数量
     */
    public void setLimit(int limit) {
        this.limit = limit;
    }

    public boolean isValid(){
        if(roleQueryType == null){
            return false;
        }
        if(limit != null && limit <= 0){
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("V2NIMTeamMemberQueryOption{");
        sb.append("roleQueryType=").append(roleQueryType);
        sb.append(", onlyChatBanned=").append(onlyChatBanned);
        sb.append(", direction=").append(direction);
        sb.append(", nextToken='").append(nextToken).append('\'');
        sb.append(", limit=").append(limit);
        sb.append('}');
        return sb.toString();
    }
}