V2NIMModifyMessageParams.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.attachment.V2NIMMessageAttachment;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageAntispamConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessagePushConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageRouteConfig;

public class V2NIMModifyMessageParams {
    /** 消息子类型 */
    private Integer subType;

    /** 消息内容 */
    private String text;

    /** 消息附属附件，根据消息类型继承实现 */
    private V2NIMMessageAttachment attachment;

    /** 消息服务端扩展，请使用
     * Json 字符串 */
    private String serverExtension;

    /** 反垃圾相关配置 */
    private V2NIMMessageAntispamConfig antispamConfig;

    /** 路由抄送相关配置 */
    private V2NIMMessageRouteConfig routeConfig;

    /** 推送相关配置 */
    private V2NIMMessagePushConfig pushConfig;

    /**
     * 是否启用本地反垃圾
     * 只针对文本消息生效
     * 发送消息时候，如果改字段为true，文本消息则走本地反垃圾检测，检测后返回V2NIMClientAntispamOperateType，
     * 返回0，直接发送该消息
     * 返回1，发送替换后的文本消息
     * 返回2，消息发送失败， 返回本地错误码
     * 返回3，消息正常发送，由服务端拦截
     */
    private boolean clientAntispamEnabled = false;

    /**
     * 反垃圾命中后替换的文本
     */
    private String clientAntispamReplace = "";

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

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

    /**
     * 获取消息内容
     * @return 消息内容
     */
    public String getText() {
        return this.text;
    }

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

    /**
     * 获取消息附属附件
     * @return 消息附属附件
     */
    public V2NIMMessageAttachment getAttachment() {
        return this.attachment;
    }

    /**
     * 设置消息附属附件
     * @param attachment 消息附属附件
     */
    public void setAttachment(V2NIMMessageAttachment attachment) {
        this.attachment = attachment;
    }

    /**
     * 获取消息服务端扩展
     * @return 消息服务端扩展
     */
    public String getServerExtension() {
        return this.serverExtension;
    }

    /**
     * 设置消息服务端扩展
     * @param serverExtension 消息服务端扩展
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }

    /**
     * 获取反垃圾相关配置
     * @return 反垃圾相关配置
     */
    public V2NIMMessageAntispamConfig getAntispamConfig() {
        if (this.antispamConfig == null) {
            return V2NIMMessageAntispamConfig.V2NIMMessageAntispamConfigBuilder.builder().build();
        } else {
            return this.antispamConfig;
        }
    }

    /**
     * 设置反垃圾相关配置
     * @param antispamConfig 反垃圾相关配置
     */
    public void setAntispamConfig(V2NIMMessageAntispamConfig antispamConfig) {
        this.antispamConfig = antispamConfig;
    }

    /**
     * 获取路由抄送相关配置
     * @return 路由抄送相关配置
     */
    public V2NIMMessageRouteConfig getRouteConfig() {
        if (this.routeConfig == null) {
            return V2NIMMessageRouteConfig.V2NIMMessageRouteConfigBuilder.builder().build();
        } else {
            return this.routeConfig;
        }
    }

    /**
     * 设置路由抄送相关配置
     * @param routeConfig 路由抄送相关配置
     */
    public void setRouteConfig(V2NIMMessageRouteConfig routeConfig) {
        this.routeConfig = routeConfig;
    }

    /**
     * 获取推送相关配置
     * @return 推送相关配置
     */
    public V2NIMMessagePushConfig getPushConfig() {
        if (this.pushConfig == null) {
            return V2NIMMessagePushConfig.V2NIMMessagePushConfigBuilder.builder().build();
        } else {
            return this.pushConfig;
        }
    }


    /**
     * 设置推送相关配置
     * @param pushConfig 推送相关配置
     */
    public void setPushConfig(V2NIMMessagePushConfig pushConfig) {
        this.pushConfig = pushConfig;
    }

    /**
     * 获取是否启用本地反垃圾
     * @return 是否启用本地反垃圾
     */
    public boolean isClientAntispamEnabled() {
        return this.clientAntispamEnabled;
    }

    /**
     * 设置是否启用本地反垃圾
     * @param clientAntispamEnabled 是否启用本地反垃圾
     */
    public void setClientAntispamEnabled(boolean clientAntispamEnabled) {
        this.clientAntispamEnabled = clientAntispamEnabled;
    }

    /**
     * 获取反垃圾命中后替换的文本
     * @return 反垃圾命中后替换的文本
     */
    public String getClientAntispamReplace() {
        return this.clientAntispamReplace;
    }

    /**
     * 设置反垃圾命中后替换的文本
     * @param clientAntispamReplace 反垃圾命中后替换的文本
     */
    public void setClientAntispamReplace(String clientAntispamReplace) {
        this.clientAntispamReplace = clientAntispamReplace;
    }

    public boolean isValid(){
        if(subType != null && subType < 0){
            return false;
        }
        if(subType != null){
            return true;
        }
        if(text != null){
            return true;
        }
        if(attachment != null){
            return true;
        }
        if(serverExtension != null){
            return true;
        }
        return false;
    }

    /**
     * V2NIMModifyMessageParams 构造器
     */
    public static final class V2NIMModifyMessageParamsBuilder {

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

        /** 消息内容 */
        private String text;

        /** 消息附属附件，根据消息类型继承实现 */
        private V2NIMMessageAttachment attachment;

        /** 消息服务端扩展，必须是Json 字符串 */
        private String serverExtension;

        /** 反垃圾相关配置 */
        private V2NIMMessageAntispamConfig antispamConfig;

        /** 路由抄送相关配置 */
        private V2NIMMessageRouteConfig routeConfig;

        /** 推送相关配置 */
        private V2NIMMessagePushConfig pushConfig;

        /**
         * 是否启用本地反垃圾
         * 只针对文本消息生效
         * 发送消息时候，如果改字段为true，文本消息则走本地反垃圾检测，检测后返回V2NIMClientAntispamOperateType，
         * 返回0，直接发送该消息
         * 返回1，发送替换后的文本消息
         * 返回2，消息发送失败， 返回本地错误码
         * 返回3，消息正常发送，由服务端拦截
         */
        private boolean clientAntispamEnabled;

        /**
         * 反垃圾命中后替换的文本
         */
        private String clientAntispamReplace;

        private V2NIMModifyMessageParamsBuilder() {
        }

        /**
         * V2NIMModifyMessageParams 构造器
         * @return V2NIMModifyMessageParamsBuilder
         */
        public static V2NIMModifyMessageParamsBuilder builder() {
            return new V2NIMModifyMessageParamsBuilder();
        }

        /**
         * 设置消息子类型
         * @param subType 消息子类型
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withSubType(int subType) {
            this.subType = subType;
            return this;
        }

        /**
         * 设置消息内容
         * @param text 消息内容
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withText(String text) {
            this.text = text;
            return this;
        }

        /**
         * 设置消息附属附件
         * @param attachment 消息附属附件
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withAttachment(V2NIMMessageAttachment attachment) {
            this.attachment = attachment;
            return this;
        }

        /**
         * 设置消息服务端扩展
         * @param serverExtension 消息服务端扩展
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withServerExtension(String serverExtension) {
            this.serverExtension = serverExtension;
            return this;
        }

        /**
         * 设置反垃圾相关配置
         * @param antispamConfig 反垃圾相关配置
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withAntispamConfig(V2NIMMessageAntispamConfig antispamConfig) {
            this.antispamConfig = antispamConfig;
            return this;
        }

        /**
         * 设置路由抄送相关配置
         * @param routeConfig 路由抄送相关配置
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withRouteConfig(V2NIMMessageRouteConfig routeConfig) {
            this.routeConfig = routeConfig;
            return this;
        }

        /**
         * 设置推送相关配置
         * @param pushConfig 推送相关配置
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withPushConfig(V2NIMMessagePushConfig pushConfig) {
            this.pushConfig = pushConfig;
            return this;
        }

        /**
         * 设置是否启用本地反垃圾
         * @param clientAntispamEnabled 是否启用本地反垃圾
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withClientAntispamEnabled(boolean clientAntispamEnabled) {
            this.clientAntispamEnabled = clientAntispamEnabled;
            return this;
        }

        /**
         * 设置反垃圾命中后替换的文本
         * @param clientAntispamReplace 反垃圾命中后替换的文本
         * @return V2NIMModifyMessageParamsBuilder
         */
        public V2NIMModifyMessageParamsBuilder withClientAntispamReplace(String clientAntispamReplace) {
            this.clientAntispamReplace = clientAntispamReplace;
            return this;
        }

        /**
         * 构建 V2NIMModifyMessageParams 对象
         * @return V2NIMModifyMessageParams
         */
        public V2NIMModifyMessageParams build() {
            V2NIMModifyMessageParams params = new V2NIMModifyMessageParams();
            params.setSubType(subType);
            params.setText(text);
            params.setAttachment(attachment);
            params.setServerExtension(serverExtension);
            params.setAntispamConfig(antispamConfig);
            params.setRouteConfig(routeConfig);
            params.setPushConfig(pushConfig);
            params.setClientAntispamEnabled(clientAntispamEnabled);
            params.setClientAntispamReplace(clientAntispamReplace);
            return params;
        }
    }
}