GetMessagesDynamicallyParam.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.netease.nimlib.sdk.msg.MessageBuilder;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.session.IMMessageImpl;
import com.netease.nimlib.session.MsgDBHelper;
import com.netease.nimlib.util.StringUtil;

import java.io.Serializable;

public class GetMessagesDynamicallyParam implements Serializable {

    /** 最大数量限制 */
    public static final int MAX_LIMIT = 100;
    /**
     * 会话ID
     */
    @NonNull
    private final String sessionId;
    /**
     * 会话类型
     */
    @NonNull
    private final SessionTypeEnum sessionType;
    /**
     * 开始时间（时间戳小）
     */
    private long fromTime;
    /**
     * 结束时间（时间戳大）
     */
    private long toTime;

    /**
     * 要排除的最后一条消息的服务器ID，用于翻页。
     * 要从A页翻到B页时，传A页中最接近B页的消息
     *
     * 设置此参数，需要同时传{@link GetMessagesDynamicallyParam#anchorClientId}
     */
    private long anchorServerId;
    /**
     * 要排除的最后一条消息的客户端ID，用于翻页。
     * 要从A页翻到B页时，传A页中最接近B页的消息
     */
    private String anchorClientId;
    /**
     * 条数限制
     * 限制0~100，否则414。其中0会被转化为100
     */
    private int limit;

    /**
     * 查询方向
     */
    @Nullable
    private GetMessageDirectionEnum direction;

    private GetMessageModeEnum mode;

    public GetMessagesDynamicallyParam(@NonNull String sessionId, @NonNull SessionTypeEnum sessionType) {
        this(sessionId, sessionType, 0, 0, 0, null, 0, GetMessageDirectionEnum.FORWARD, GetMessageModeEnum.DEFAULT);
    }

    public GetMessagesDynamicallyParam(@NonNull String sessionId, @NonNull SessionTypeEnum sessionType, long fromTime, long toTime, long anchorServerId, String anchorClientId, int limit, @Nullable GetMessageDirectionEnum direction) {
        this(sessionId, sessionType, fromTime, toTime, anchorServerId, anchorClientId, limit, direction, GetMessageModeEnum.DEFAULT);
    }

    private GetMessagesDynamicallyParam(@NonNull String sessionId, @NonNull SessionTypeEnum sessionType, long fromTime, long toTime, long anchorServerId, String anchorClientId, int limit, @Nullable GetMessageDirectionEnum direction, @Nullable GetMessageModeEnum mode) {
        this.sessionId = sessionId;
        this.sessionType = sessionType;
        this.fromTime = fromTime;
        this.toTime = toTime;
        this.anchorServerId = anchorServerId;
        this.anchorClientId = anchorClientId;
        this.limit = limit;
        this.direction = direction;
        this.mode = mode == null ? GetMessageModeEnum.DEFAULT : mode;
    }

    @NonNull
    public String getSessionId() {
        return sessionId;
    }

    @NonNull
    public SessionTypeEnum getSessionType() {
        return sessionType;
    }

    public long getFromTime() {
        return fromTime;
    }

    public void setFromTime(long fromTime) {
        this.fromTime = fromTime;
    }

    public long getToTime() {
        return toTime;
    }

    public void setToTime(long toTime) {
        this.toTime = toTime;
    }

    public long getAnchorServerId() {
        return anchorServerId;
    }

    public void setAnchorServerId(long anchorServerId) {
        this.anchorServerId = anchorServerId;
    }

    public String getAnchorClientId() {
        return anchorClientId;
    }

    public void setAnchorClientId(String anchorClientId) {
        this.anchorClientId = anchorClientId;
    }

    public int getLimit() {
        return limit;
    }

    public void setLimit(int limit) {
        this.limit = limit;
    }

    public GetMessageDirectionEnum getDirection() {
        return direction;
    }

    public void setDirection(GetMessageDirectionEnum direction) {
        this.direction = direction;
    }

    public GetMessageModeEnum getMode() {
        return mode;
    }

    public void setMode(GetMessageModeEnum mode) {
        this.mode = mode == null ? GetMessageModeEnum.DEFAULT : mode;
    }

    /**
     * 可能会查询数据库
     */
    @NonNull
    public IMMessage getAnchor() {
        String clientId = this.getAnchorClientId();
        if (StringUtil.isNotEmpty(clientId)) {
            IMMessage anchor = MsgDBHelper.queryMessageByUuid(clientId);
            if (anchor instanceof IMMessageImpl) {
                return anchor;
            }
        }
        long anchorTime = this.getDirection() == GetMessageDirectionEnum.BACKWARD ? this.getFromTime() : this.getToTime();
        IMMessageImpl anchor = (IMMessageImpl) MessageBuilder.createEmptyMessage(this.getSessionId(), this.getSessionType(), anchorTime);
        anchor.setUuid(this.getAnchorClientId());
        anchor.setServerId(this.getAnchorServerId());
        return anchor;
    }

    public GetMessagesDynamicallyParam createStandardizedParam() {
        String formedSessionId = this.sessionId;
        SessionTypeEnum formedSessionType = this.sessionType == null ? SessionTypeEnum.None : this.sessionType;
        long formedFromTime = this.fromTime;
        long formedToTime = this.toTime;
        long formedExcludeServerId = this.anchorServerId;
        String formedExcludeClientId = this.anchorClientId;
        int formedLimit = this.limit;
        formedLimit = formedLimit <= 0 ? GetMessagesDynamicallyParam.MAX_LIMIT : formedLimit;
        formedLimit = Math.min(formedLimit, GetMessagesDynamicallyParam.MAX_LIMIT);
        GetMessageDirectionEnum formedDirection = this.direction == null ? GetMessageDirectionEnum.FORWARD : this.direction;
        GetMessageModeEnum mode = this.mode == null ? GetMessageModeEnum.DEFAULT : this.mode;
        return new GetMessagesDynamicallyParam(formedSessionId, formedSessionType, formedFromTime, formedToTime, formedExcludeServerId, formedExcludeClientId, formedLimit, formedDirection, mode);
    }

    /**
     * 参数合法的初阶判断函数
     *
     * @return 初步筛查是否合法的结果
     */
    public boolean isValid() {
        return StringUtil.isNotEmpty(sessionId)
                && (sessionType == SessionTypeEnum.P2P || sessionType == SessionTypeEnum.Team || sessionType == SessionTypeEnum.SUPER_TEAM)
                && fromTime >= 0
                && toTime >= 0
                && limit >= 0 && limit <= MAX_LIMIT
                && (anchorServerId == 0 || StringUtil.isNotEmpty(anchorClientId));
    }

    @Override
    public String toString() {
        return "GetMessagesDynamicallyParam{" +
                "sessionId='" + sessionId + '\'' +
                ", sessionType=" + sessionType +
                ", fromTime=" + fromTime +
                ", toTime=" + toTime +
                ", excludeServerId=" + anchorServerId +
                ", excludeClientId='" + anchorClientId + '\'' +
                ", limit=" + limit +
                ", direction=" + direction +
                ", mode=" + mode +
                '}';
    }
}