V2NIMChatroomMessageListOption.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 java.io.Serializable;
import java.util.List;

/**
 * 聊天室消息查询选项
 */
public class V2NIMChatroomMessageListOption implements Serializable {
    /**
     * 消息查询方向, 默认为{@link V2NIMMessageQueryDirection#V2NIM_QUERY_DIRECTION_DESC}
     */
    private V2NIMMessageQueryDirection direction;
    /**
     * 根据消息类型查询消息， 为null或空列表， 则表示查询所有消息类型
     */
    private List<V2NIMMessageType>     messageTypes;
    /**
     * 消息查询开始时间，首次传0，单位毫秒
     */
    private Long beginTime;
    /**
     * 每次查询条数
     */
    private Integer limit;

    public V2NIMChatroomMessageListOption() {
    }

    /**
     *
     * @param direction 消息查询方向
     * @param messageTypes 根据消息类型查询消息， 为null或空列表， 则表示查询所有消息类型
     * @param beginTime 消息查询开始时间，首次传0，单位毫秒
     * @param limit 每次查询条数
     */
    public V2NIMChatroomMessageListOption(V2NIMMessageQueryDirection direction, List<V2NIMMessageType> messageTypes, long beginTime, int limit) {
        this.direction = direction;
        this.messageTypes = messageTypes;
        this.beginTime = beginTime;
        this.limit = limit;
    }

    /**
     * 获取消息查询方向
     * @return 消息查询方向
     */
    public V2NIMMessageQueryDirection getDirection() {
        if(direction == null) {
            return V2NIMMessageQueryDirection.V2NIM_QUERY_DIRECTION_DESC;
        }
        else {
            return direction;
        }
    }

    /**
     * 获取查询消息的类型列表
     * @return 查询消息的类型列表
     */
    public List<V2NIMMessageType> getMessageTypes() {
        return messageTypes;
    }

    /**
     * 获取消息查询开始时间
     * @return 消息查询开始时间
     */
    public long getBeginTime() {
        if (beginTime == null) {
            return 0;
        }
        return beginTime;
    }

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

    /**
     * 设置消息查询方向
     * @param direction 消息查询方向
     */
    public void setDirection(V2NIMMessageQueryDirection direction) {
        this.direction = direction;
    }

    /**
     * 设置查询消息的类型列表
     * @param messageTypes 查询消息的类型列表
     */
    public void setMessageTypes(List<V2NIMMessageType> messageTypes) {
        this.messageTypes = messageTypes;
    }

    /**
     * 设置消息查询开始时间
     * @param beginTime 消息查询开始时间
     */
    public void setBeginTime(long beginTime) {
        this.beginTime = beginTime;
    }

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

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