QChatSendMessageParam.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;
import com.netease.nimlib.qchat.QChatAuthCache;
import com.netease.nimlib.qchat.model.QChatMessageImpl;
import com.netease.nimlib.sdk.msg.attachment.MsgAttachment;
import com.netease.nimlib.sdk.msg.constant.MsgDirectionEnum;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.qchat.model.QChatMessage;
import com.netease.nimlib.sdk.qchat.model.QChatMessageAntiSpamOption;
import com.netease.nimlib.util.StringUtil;
import java.util.List;
import java.util.Map;

/**
 * "发送消息"接口入参
 */
public class QChatSendMessageParam {

    private static final String TAG = "QChatSendMessageParam";
    /**
     * 消息所属的serverId，必填
     */
    @NonNull
    private final Long serverId;
    /**
     * 消息所属的channelId，必填
     */
    @NonNull
    private final Long channelId;
    /**
     * 消息类型, 同TalkMsgTag，必填
     */
    @NonNull
    private final MsgTypeEnum type;
    /**
     * 消息body
     */
    private String body;
    /**
     * 消息附件，通过MsgAttachment#toJson(false)获得
     */
    private String attach;
    /**
     * 消息自定义扩展，SDK会转成json字符串使用
     */
    private Map<String, Object> extension;
    /**
     * 第三方自定义的推送属性，SDK会转成json字符串使用
     */
    private Map<String, Object> pushPayload;
    /**
     * 自定义推送文案
     */
    private String pushContent;
    /**
     * 被艾特的人的accid列表
     */
    private List<String> mentionedAccidList;
    /**
     * 被艾特的身份组的roleid列表
     */
    private List<Long> mentionedRoleIdList;
    /**
     * 是否艾特所有人，0:不是，1:是，默认0
     */
    private boolean mentionedAll = false;
    /**
     * 该消息是否存储云端历史，0:不支持，1:支持, 默认1
     */
    private boolean historyEnable = true;
    /**
     * 是否需要推送，默认true
     */
    private boolean pushEnable = true;
    /**
     * 是否需要消息计数，默认true
     */
    private boolean needBadge = true;
    /**
     * 是否需要推送昵称，默认true
     */
    private boolean needPushNick = true;
    /**
     * 是否需要抄送，默认true
     */
    private boolean isRouteEnable = true;


    /**
     * 消息的uuid
     * 不是重发的消息，uuid有客户端SDK自动生成
     * 重发的消息，复用被重发消息的uuid
     */
    private final String uuid;

    /**
     * 状态，可以自定义(status>= 10000)
     */
    private Integer                    serverStatus;
    /**
     * 环境变量,用户可以根据不同的env配置不同的抄送和回调地址
     */
    private String env;
    /**
     * 消息反垃圾配置选项
     */
    private QChatMessageAntiSpamOption antiSpamOption;

    /**
     * 消息子类型
     */
    private Integer subType;

    /**
     *
     * @param serverId 消息所属的serverId
     * @param channelId 消息所属的channelId
     * @param type 消息类型
     */
    public QChatSendMessageParam(long serverId, long channelId, @NonNull MsgTypeEnum type) {
        this.serverId = serverId;
        this.channelId = channelId;
        this.type = type;

        this.uuid = StringUtil.get32UUID();
    }

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

    /**
     * 设置消息附件，通过MsgAttachment#toJson(false)获得
     * @param attach 消息附件
     */
    public void setAttach(String attach) {
        this.attach = attach;
    }

    /**
     * 设置消息附件
     * @param attachment 消息附件类
     */
    public void setAttachment(MsgAttachment attachment) {
        this.attach = attachment.toJson(false);
    }

    /**
     * 设置扩展字段
     * @param extension
     */
    public void setExtension(Map<String, Object> extension) {
        this.extension = extension;
    }

    /**
     * 设置推送payload
     * @param pushPayload
     */
    public void setPushPayload(Map<String, Object> pushPayload) {
        this.pushPayload = pushPayload;
    }

    /**
     * 设置推送文案
     * @param pushContent
     */
    public void setPushContent(String pushContent) {
        this.pushContent = pushContent;
    }

    /**
     * 设置@账号列表
     * @param mentionedAccidList
     */
    public void setMentionedAccidList(List<String> mentionedAccidList) {
        this.mentionedAccidList = mentionedAccidList;
    }

    /**
     * 设置@身份组的RoleId列表
     * @param mentionedRoleIdList
     */
    public void setMentionedRoleIdList(List<Long> mentionedRoleIdList) {
        this.mentionedRoleIdList = mentionedRoleIdList;
    }

    /**
     * 设置是否@所有人
     * @param mentionedAll
     */
    public void setMentionedAll(boolean mentionedAll) {
        this.mentionedAll = mentionedAll;
    }

    /**
     * 设置是否消息是否存储云端历史
     * @param historyEnable
     */
    public void setHistoryEnable(boolean historyEnable) {
        this.historyEnable = historyEnable;
    }

    /**
     * 设置是否需要推送
     * @param pushEnable
     */
    public void setPushEnable(boolean pushEnable) {
        this.pushEnable = pushEnable;
    }

    /**
     * 设置是否需要消息计数
     * @param needBadge
     */
    public void setNeedBadge(boolean needBadge) {
        this.needBadge = needBadge;
    }

    /**
     * 设置是否需要推送昵称
     * @param needPushNick
     */
    public void setNeedPushNick(boolean needPushNick) {
        this.needPushNick = needPushNick;
    }

    /**
     * 获取服务器id
     * @return
     */
    @NonNull
    public Long getServerId() {
        return serverId;
    }

    /**
     * 获取频道id
     * @return
     */
    @NonNull
    public Long getChannelId() {
        return channelId;
    }

    /**
     * 获取消息类型
     * @return
     */
    @NonNull
    public MsgTypeEnum getType() {
        return type;
    }

    /**
     * 获取消息内容
     * @return
     */
    public String getBody() {
        return body;
    }

    /**
     * 获取消息附件字符串
     * @return
     */
    public String getAttach() {
        return attach;
    }

    /**
     * 获取扩展字段
     * @return
     */
    public Map<String, Object> getExtension() {
        return extension;
    }

    /**
     * 获取推送payload
     * @return
     */
    public Map<String, Object> getPushPayload() {
        return pushPayload;
    }

    /**
     * 获取推送文案
     * @return
     */
    public String getPushContent() {
        return pushContent;
    }

    /**
     * 获取@账号列表
     * @return
     */
    public List<String> getMentionedAccidList() {
        return mentionedAccidList;
    }

    /**
     * 设置@身份组的RoleId列表
     * @return
     */
    public List<Long> getMentionedRoleIdList() {
        return mentionedRoleIdList;
    }

    /**
     * 是否@所有人
     * @return
     */
    public boolean isMentionedAll() {
        return mentionedAll;
    }

    /**
     * 是否消息在云端存储，默认true
     * @return
     */
    public boolean isHistoryEnable() {
        return historyEnable;
    }

    /**
     * 是否需要推送，默认true
     * @return
     */
    public boolean isPushEnable() {
        return pushEnable;
    }

    /**
     * 是否需要消息计数，默认true
     * @return
     */
    public boolean isNeedBadge() {
        return needBadge;
    }

    /**
     * 是否需要推送昵称，默认true
     * @return
     */
    public boolean isNeedPushNick() {
        return needPushNick;
    }

    /**
     * 获取消息uuid
     * @return
     */
    public String getUuid() {
        return uuid;
    }

    /**
     * 获取消息服务器状态
     * @return
     */
    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;
    }

    /**
     * 是否需要抄送，默认true
     * @return
     */
    public boolean isRouteEnable() {
        return isRouteEnable;
    }

    /**
     * 设置是否需要抄送
     * @param routeEnable
     */
    public void setRouteEnable(boolean routeEnable) {
        isRouteEnable = routeEnable;
    }

    /**
     * 获取环境变量
     * 用户可以根据不同的env配置不同的抄送和回调地址
     *
     * @return 环境变量
     */
    public String getEnv() {
        return env;
    }

    /**
     * 设置环境变量
     * 用户可以根据不同的env配置不同的抄送和回调地址
     *
     * @param env 环境变量
     */
    public void setEnv(String env) {
        this.env = env;
    }

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

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

    private QChatMessageImpl qChatMessage;

    /**
     * 将QChatSendMessageParam转换成QChatMessage
     * @return
     */
    public synchronized QChatMessage toQChatMessage() {
        if (qChatMessage == null) {
            qChatMessage = QChatMessageImpl.fromParam(this);
            qChatMessage.setFromAccount(QChatAuthCache.getInstance().getCurrentAccount());
            qChatMessage.setDirect(MsgDirectionEnum.Out);
        }else
        {
            QChatMessageImpl.fromParam(this,qChatMessage);
        }

        return qChatMessage;
    }
}