V2NIMConversationOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.conversation.enums.V2NIMConversationType;
import java.util.List;

/**
 * 会话查询选项
 */
public class V2NIMConversationOption {

    /**
     * 会话类型列表,为空表示查询所有类型，否则查询指定对话类型
     */
    private List<V2NIMConversationType> conversationTypes = null;
    /**
     * 是否只查询包含未读的会话，默认false
     */
    private boolean                     onlyUnread        = false;
    /**
     * 会话分组id列表,empty: 查询未分组的会话，null: 查询所有分组，否则查询指定分组
     */
    private List<String> conversationGroupIds = null;


    public V2NIMConversationOption() {
    }

    /**
     * @param conversationTypes 会话类型列表,为空表示查询所有类型，否则查询指定对话类型
     */
    public V2NIMConversationOption(List<V2NIMConversationType> conversationTypes) {
        this.conversationTypes = conversationTypes;
    }

    /**
     * @param conversationTypes      会话类型列表,为空表示查询所有类型，否则查询指定对话类型
     * @param onlyUnread 是否只查询包含未读的会话
     */
    public V2NIMConversationOption(List<V2NIMConversationType> conversationTypes, boolean onlyUnread) {
        this.conversationTypes = conversationTypes;
        this.onlyUnread = onlyUnread;
    }

    /**
     * @param conversationTypes      会话类型列表,为空表示查询所有类型，否则查询指定对话类型
     * @param onlyUnread 是否只查询包含未读的会话
     * @param conversationGroupIds 会话分组id列表,为空表示查询所有分组，否则查询指定分组
     */
    public V2NIMConversationOption(List<V2NIMConversationType> conversationTypes, boolean onlyUnread, List<String> conversationGroupIds) {
        this.conversationTypes = conversationTypes;
        this.onlyUnread = onlyUnread;
        this.conversationGroupIds = conversationGroupIds;
    }

    /**
     * 获取会话类型列表
     *
     * @return 会话类型列表
     */
    public List<V2NIMConversationType> getConversationTypes() {
        return conversationTypes;
    }

    /**
     * 设置会话类型列表
     *
     * @param conversationTypes 会话类型列表
     */
    public void setConversationTypes(List<V2NIMConversationType> conversationTypes) {
        this.conversationTypes = conversationTypes;
    }

    /**
     * 设置会话分组id列表
     *
     * @param conversationGroupIds 会话分组id列表
     */
    public void setConversationGroupIds(List<String> conversationGroupIds) {
        this.conversationGroupIds = conversationGroupIds;
    }

    /**
     * 是否只查询包含未读的会话
     *
     * @return true表示只查询包含未读的会话，false表示查询所有会话
     */
    public boolean isOnlyUnread() {
        return onlyUnread;
    }

    /**
     * 设置是否只查询包含未读的会话
     *
     * @param onlyUnread true表示只查询包含未读的会话，false表示查询所有会话
     */
    public void setOnlyUnread(boolean onlyUnread) {
        this.onlyUnread = onlyUnread;
    }

    /**
     * 获取会话分组id列表
     *
     * @return 会话分组id列表
     */
    public List<String> getConversationGroupIds() {
        return conversationGroupIds;
    }

    @Override
    public String toString() {
        return "V2NIMConversationOption{" + "conversationTypes=" + conversationTypes + ", onlyUnread=" + onlyUnread + ", conversationGroupIds="
                + conversationGroupIds + '}';
    }
}