GetMessagesByTagsParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.chatroom.model;

import com.netease.nimlib.notifier.support26.annotation.NonNull;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;

import java.util.List;

public class GetMessagesByTagsParam {
    /**
     * 聊天室ID
     */
    private final long roomId;
    /**
     * 标签
     */
    private final List<String> tags;

    /**
     * 消息类型列表
     * 只查询指定消息类型的消息
     */
    private List<MsgTypeEnum> types;
    /**
     * 起始时间ms
     */
    private Long fromTime;
    /**
     * 结束时间ms
     */
    private Long toTime;
    /**
     * 最大消息数量
     */
    private Integer limit;
    /**
     * 是否反向
     */
    private Boolean reverse;

    /**
     * 构造函数
     *
     * @param roomId 聊天室ID
     * @param tags 标签
     */
    public GetMessagesByTagsParam(long roomId, @NonNull List<String> tags) {
        this.roomId = roomId;
        this.tags = tags;
    }

    /**
     * @return 聊天室ID
     */
    public long getRoomId() {
        return roomId;
    }

    /**
     * @return 标签
     */
    public List<String> getTags() {
        return tags;
    }

    /**
     * 只查询指定消息类型的
     * @return 消息类型
     */
    public List<MsgTypeEnum> getTypes() {
        return types;
    }

    /**
     * 设置消息类型限制，只查询指定消息类型的消息
     * @param types 消息类型
     */
    public void setTypes(List<MsgTypeEnum> types) {
        this.types = types;
    }

    /**
     * 起始时间限制，只查询≥起始时间的消息
     * @return 起始时间ms
     */
    public Long getFromTime() {
        return fromTime;
    }

    /**
     * 设置起始时间限制，只查询≥起始时间的消息
     * @param fromTime 起始时间ms
     */
    public void setFromTime(Long fromTime) {
        this.fromTime = fromTime;
    }

    /**
     * 结束时间限制，只查询≤结束时间的消息
     * @return 结束时间
     */
    public Long getToTime() {
        return toTime;
    }

    /**
     * 设置结束时间限制，只查询≤结束时间的消息
     * @param toTime 结束时间ms
     */
    public void setToTime(Long toTime) {
        this.toTime = toTime;
    }

    /**
     * 数量限制，只结果只包含前面指定条数的消息
     * @return 最大消息数量
     */
    public Integer getLimit() {
        return limit;
    }

    /**
     * 设置数量限制，只结果只包含前面指定条数的消息
     * @param limit 最大消息数量
     */
    public void setLimit(Integer limit) {
        this.limit = limit;
    }

    /**
     * 查询顺序
     * @return 是否反向
     */
    public Boolean getReverse() {
        return reverse;
    }

    /**
     * 设置查询顺序
     * @param reverse 是否反向
     */
    public void setReverse(Boolean reverse) {
        this.reverse = reverse;
    }

    @Override
    public String toString() {
        return "GetMessagesByTagsParam{" +
                "roomId=" + roomId +
                ", tags=" + tags +
                ", messageTypes=" + types +
                ", fromTime=" + fromTime +
                ", toTime=" + toTime +
                ", limit=" + limit +
                ", reverse=" + reverse +
                '}';
    }
}