QChatUpdateMessageParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat.param;

import androidx.annotation.NonNull;
import com.netease.nimlib.sdk.qchat.model.QChatMessageAntiSpamOption;
import java.util.Map;

/**
 * "更新消息"接口入参
 */
public class QChatUpdateMessageParam {

    /**
     * 更新操作通用参数，必填
     */
    @NonNull
    private final QChatUpdateParam updateParam;
    /**
     * 消息所属的serverId，必填
     */
    @NonNull
    private final Long serverId;
    /**
     * 消息所属的channelId，必填
     */
    @NonNull
    private final Long channelId;
    /**
     * 消息发送时间，从QChatMessage中获取，不可随便设置，必填
     */
    @NonNull
    private final Long time;
    /**
     * 服务端生成的消息id，全局唯一，必填
     */
    @NonNull
    private final Long msgIdServer;
    /**
     * 消息body
     */
    private       String         body;
    /**
     * 消息自定义扩展
     */
    private Map<String, Object>        extension;

    /**
     * 状态，可以自定义(status>= 10000)
     */
    private Integer serverStatus;

    /**
     * 消息反垃圾配置选项
     */
    private QChatMessageAntiSpamOption antiSpamOption;
    /**
     * 消息子类型
     */
    private Integer subType;

    /**
     *
     * @param updateParam 更新操作通用参数
     * @param serverId 服务器Id
     * @param channelId 频道Id
     * @param time 息发送时间，从QChatMessage中获取，不可随便设置
     * @param msgIdServer 服务端生成的消息id
     */
    public QChatUpdateMessageParam(@NonNull QChatUpdateParam updateParam, long serverId, long channelId, long time, long msgIdServer) {
        this.updateParam = updateParam;
        this.serverId = serverId;
        this.channelId = channelId;
        this.time = time;
        this.msgIdServer = msgIdServer;
    }

    /**
     * 获取更新操作通用参数
     */
    @NonNull
    public QChatUpdateParam getUpdateParam() {
        return updateParam;
    }

    /**
     * 获取消息所属的serverId
     */
    @NonNull
    public Long getServerId() {
        return serverId;
    }

    /**
     * 获取消息所属的channelId
     */
    @NonNull
    public Long getChannelId() {
        return channelId;
    }

    /**
     * 获取消息发送时间
     */
    @NonNull
    public Long getTime() {
        return time;
    }

    /**
     * 获取服务端生成的消息id
     */
    @NonNull
    public Long getMsgIdServer() {
        return msgIdServer;
    }

    /**
     * 获取更新的消息body
     */
    public String getBody() {
        return body;
    }

    /**
     * 设置更新的消息body
     * @param body
     */
    public void setBody(String body) {
        this.body = body;
    }

    /**
     * 获取更新的消息自定义扩展
     */
    public Map<String, Object> getExtension() {
        return extension;
    }

    /**
     * 设置更新的消息自定义扩展
     * @param extension
     */
    public void setExtension(Map<String, Object> extension) {
        this.extension = extension;
    }

    /**
     * 获取更新的消息状态
     */
    public Integer getServerStatus() {
        return serverStatus;
    }

    /**
     * 设置消息状态，只能设置成自定义的状态(status>= 10000)，否则提示414参数错误
     * @param serverStatus
     */
    public void setServerStatus(Integer serverStatus) {
        this.serverStatus = serverStatus;
    }

    /**
     * 获取消息反垃圾配置选项
     * @return
     */
    public QChatMessageAntiSpamOption getAntiSpamOption() {
        return antiSpamOption;
    }

    /**
     * 设置消息反垃圾配置选项
     * @param antiSpamOption
     */
    public void setAntiSpamOption(QChatMessageAntiSpamOption antiSpamOption) {
        this.antiSpamOption = antiSpamOption;
    }

    /**
     * 获取消息子类型
     * @return
     */
    public Integer getSubType() {
        return subType;
    }

    /**
     * 设置消息子类型
     * @param subType
     */
    public void setSubType(Integer subType) {
        this.subType = subType;
    }
}