V2NIMThreadMessageListOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.V2NIMMessageRefer;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMQueryDirection;
import com.netease.nimlib.v2.message.impl.V2NIMMessageReferImpl;
import java.io.Serializable;

/**
 * Thread消息列表查询参数
 */
public class V2NIMThreadMessageListOption implements Serializable {

    /**
     * 根消息引用
     */
    private V2NIMMessageRefer messageRefer;
    /**
     * 查询开始时间，闭区间，小于等于 endTime
     * 默认从0开始查询
     */
    private long beginTime = 0L;
    /**
     * 查询结束时间，闭区间
     * 默认当前时间+1个小时
     */
    private long endTime = 0L;
    /**
     * 锚点消息ServerId，根据锚点消息查询，不包含该消息
     * 默认为"0"
     */
    private String excludeMessageServerId = null;
    /**
     * 每次查询条数，默认50，必须大于 0， 小于等于0报参数错误
     */
    private Integer limit = 50;
    /**
     * 消息查询方向，默认V2NIM_QUERY_DIRECTION_DESC
     */
    private V2NIMQueryDirection direction = V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC;

    /**
     * 获取根消息引用
     * @return 根消息引用
     */
    public V2NIMMessageRefer getMessageRefer() {
        return messageRefer;
    }
    /**
     * 设置根消息引用
     * @param messageRefer 根消息引用
     */
    public void setMessageRefer(V2NIMMessageRefer messageRefer) {
        this.messageRefer = messageRefer;
    }

    /**
     * 获取查询开始时间
     * @return 查询开始时间
     */
    public long getBeginTime() {
        return beginTime;
    }

    /**
     * 设置查询开始时间
     * @param beginTime 查询开始时间
     */
    public void setBeginTime(long beginTime) {
        this.beginTime = beginTime;
    }
    /**
     * 获取查询结束时间
     * @return 查询结束时间
     */
    public long getEndTime() {
        return endTime;
    }

    /**
     * 设置查询结束时间
     * @param endTime
     */
    public void setEndTime(long endTime) {
        this.endTime = endTime;
    }

    /**
     * 获取锚点消息ServerId
     * @return
     */
    public String getExcludeMessageServerId() {
        return excludeMessageServerId;
    }

    /**
     * 设置锚点消息ServerId
     * @param excludeMessageServerId
     */
    public void setExcludeMessageServerId(String excludeMessageServerId) {
        this.excludeMessageServerId = excludeMessageServerId;
    }

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

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

    /**
     * 获取查询方向
     * @return 查询方向
     */
    public V2NIMQueryDirection getDirection() {
        return direction;
    }

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

    public boolean isValid() {
        if(!V2NIMMessageReferImpl.isValid(messageRefer)) {
            return false;
        }
        if(limit <= 0) {
            return false;
        }

        if(beginTime != 0L && endTime != 0L && beginTime > endTime) {
            return false;
        }
        return true;
    }
}