V2NIMChatroomTagMessageOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageQueryDirection;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageType;
import com.netease.nimlib.util.CollectionUtil;
import java.io.Serializable;
import java.util.List;

/**
 * 根据tag查询消息参数
 */
public class V2NIMChatroomTagMessageOption implements Serializable {

    /**
     * 查询的tags， 为空，或者size为0， 返回参数错误
     */
    private List<String> tags;
    /**
     * 根据消息类型查询消息， 为null或空列表， 则表示查询所有消息类型
     */
    private List<V2NIMMessageType>     messageTypes;
    /**
     * 消息查询开始时间，首次传0，单位毫秒
     */
    private Long                       beginTime;
    /**
     * 消息查询结束时间，默认当前时间，单位毫秒
     */
    private Long                       endTime;
    /**
     * 每次查询条数
     * 必须大于 0， 小于等于0报参数错误
     */
    private Integer limit;
    /**
     * 消息查询方向, 默认为{@link V2NIMMessageQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     */
    private V2NIMMessageQueryDirection direction;

    /**
     * 获取查询的tags
     * @return 查询的tags， 为空，或者size为0， 返回参数错误
     */
    public List<String> getTags() {
        return tags;
    }

    /**
     * 获取根据消息类型查询消息， 为null或空列表， 则表示查询所有消息类型
     * @return 根据消息类型查询消息， 为null或空列表， 则表示查询所有消息类型
     */
    public List<V2NIMMessageType> getMessageTypes() {
        return messageTypes;
    }

    /**
     * 获取消息查询开始时间，首次传0，单位毫秒
     * @return 消息查询开始时间，首次传0，单位毫秒
     */
    public long getBeginTime() {
        if(beginTime == null){
            return 0;
        }
        return beginTime;
    }

    /**
     * 获取消息查询结束时间，默认当前时间，单位毫秒
     * @return 消息查询结束时间，默认当前时间，单位毫秒
     */
    public long getEndTime() {
        if(endTime == null){
            return 0;
        }
        return endTime;
    }

    /**
     * 获取每次查询条数
     * @return 每次查询条数
     */
    public Integer getLimit() {
        if(limit == null){
            return 100;
        }
        return limit;
    }

    /**
     * 获取消息查询方向, 默认为{@link V2NIMMessageQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     * @return 消息查询方向, 默认为{@link V2NIMMessageQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     */
    public V2NIMMessageQueryDirection getDirection() {
        if(direction == null){
            return V2NIMMessageQueryDirection.V2NIM_QUERY_DIRECTION_DESC;
        }
        return direction;
    }

    /**
     * 设置查询的tags， 为空，或者size为0， 返回参数错误
     * @param tags
     */
    public void setTags(List<String> tags) {
        this.tags = tags;
    }

    /**
     * 设置根据消息类型查询消息， 为null或空列表， 则表示查询所有消息类型
     * @param messageTypes
     */
    public void setMessageTypes(List<V2NIMMessageType> messageTypes) {
        this.messageTypes = messageTypes;
    }

    /**
     * 设置消息查询开始时间，首次传0，单位毫秒
     * @param beginTime
     */
    public void setBeginTime(Long beginTime) {
        this.beginTime = beginTime;
    }

    /**
     * 设置消息查询结束时间，默认当前时间，单位毫秒
     * @param endTime
     */
    public void setEndTime(Long endTime) {
        this.endTime = endTime;
    }

    /**
     * 设置每次查询条数
     * @param limit
     */
    public void setLimit(Integer limit) {
        this.limit = limit;
    }

    /**
     * 设置消息查询方向, 默认为{@link V2NIMMessageQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     * @param direction
     */
    public void setDirection(V2NIMMessageQueryDirection direction) {
        this.direction = direction;
    }

    public boolean isValid() {
        if(CollectionUtil.isEmpty(tags)){
            return false;
        }
        if(getLimit() <= 0){
            return false;
        }
        if(getEndTime() > 0 && getBeginTime() > getEndTime()){
            return false;
        }
        if(messageTypes != null && messageTypes.contains(null)){
            return false;
        }
        return true;
    }
}