V2NIMChatroomMemberQueryOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.chatroom.enums.V2NIMChatroomMemberRole;
import java.io.Serializable;
import java.util.List;

/**
 * 分页查询聊天室成员参数
 */
public class V2NIMChatroomMemberQueryOption implements Serializable {

    /**
     * 需要查询的成员类型,如果列表为空，表示查询所有类型的成员
     */
    private List<V2NIMChatroomMemberRole> memberRoles;
    /**
     * 是否只返回黑名单成员
     */
    private Boolean onlyBlocked;
    /**
     * 是否只返回禁言用户
     */
    private Boolean onlyChatBanned;
    /**
     * 是否只查询在线成员， 只针对固定成员生效，其他类型成员只有在线状态
     */
    private Boolean             onlyOnline;
    /**
     * 偏移量
     * 首次传“”， 后续查询传前一次返回的pageToken
     */
    private String pageToken;
    /**
     * 查询数量
     */
    private Integer limit;

    /**
     * 获取需要查询的成员类型,如果列表为空，表示查询所有类型的成员
     * @return 需要查询的成员类型
     */
    public List<V2NIMChatroomMemberRole> getMemberRoles() {
        return memberRoles;
    }

    /**
     * 是否只返回黑名单成员
     * @return true： 只返回黑名单成员, false：所有成员
     */
    public boolean isOnlyBlocked() {
        return Boolean.TRUE.equals(onlyBlocked);
    }

    /**
     * 是否只返回禁言用户
     * @return true： 只返回禁言用户, fasle：返回所有用户
     */
    public boolean isOnlyChatBanned() {
        return Boolean.TRUE.equals(onlyChatBanned);
    }

    /**
     * 获取是否只查询在线成员，只针对固定成员生效，其他类型成员只有在线状态
     * @return true： 只返回在线成员, false：全部成员
     */
    public boolean isOnlyOnline() {
        return Boolean.TRUE.equals(onlyOnline);
    }

    public String getPageToken() {
        if(pageToken == null){
            return "";
        }
        return pageToken;
    }

    /**
     * 获取查询数量
     * @return 查询数量
     */
    public int getLimit() {
        if(limit == null){
            return 100;
        }
        return limit;
    }

    /**
     * 设置需要查询的成员类型,如果列表为空，表示查询所有类型的成员
     * @param memberRoles 需要查询的成员类型
     */
    public void setMemberRoles(List<V2NIMChatroomMemberRole> memberRoles) {
        this.memberRoles = memberRoles;
    }

    /**
     * 设置是否只返回黑名单成员
     * @param onlyBlocked true： 只返回黑名单成员, false：所有成员
     */
    public void setOnlyBlocked(boolean onlyBlocked) {
        this.onlyBlocked = onlyBlocked;
    }

    /**
     * 设置是否只返回禁言用户
     * @param onlyChatBanned true： 只返回禁言用户, fasle：返回所有用户
     */
    public void setOnlyChatBanned(boolean onlyChatBanned) {
        this.onlyChatBanned = onlyChatBanned;
    }

    /**
     * 设置是否只查询在线成员， 只针对固定成员生效，其他类型成员只有在线状态
     * @param onlyOnline true： 只返回在线成员, false：全部成员
     */
    public void setOnlyOnline(boolean onlyOnline) {
        this.onlyOnline = onlyOnline;
    }

    public void setPageToken(String pageToken) {
        this.pageToken = pageToken;
    }

    /**
     * 设置查询数量
     * @param limit 查询数量
     */
    public void setLimit(int limit) {
        this.limit = limit;
    }

    public boolean isValid() {
        if(getLimit() <= 0){
            return false;
        }
        if(memberRoles != null && memberRoles.contains(null)){
            return false;
        }
        return true;
    }
}