V2NIMMessageAntispamConfig.java

浏览该文件的文档.

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

import java.io.Serializable;

public class V2NIMMessageAntispamConfig implements Serializable {

    // 指定是否需要过安全通（对于已开通安全通的用户有效，默认消息都会走安全通，如果对单条消息设置 enable 为false，则此消息不会走安全通）。
    // 该字段为true，以下字段(antispamBusinessId/antispamCustomMessage/antispamCheating/antispamExtension)才生效
    private final boolean antispamEnabled;

    // 指定易盾业务id，而不使用云信后台配置的
    // 安全通后台对接易盾
    private final String antispamBusinessId;

    // 自定义消息中需要反垃圾的内容（仅当消息类型为自定义消息时有效）
    // 自定义消息开发者自定义的反垃圾字段， content 必须是 json 格式，长度不超过 5000 字节，格式如下 { "type": 1, //1:文本，2：图片，3视频 "data": "" //文本内容or图片地址or视频地址 }
    private final String antispamCustomMessage;

    // 易盾反作弊（辅助检测数据），json格式，限制长度1024
    private final String antispamCheating;

    // 易盾反垃圾（增强检测数据），json格式，限制长度1024
    private final String antispamExtension;

    private V2NIMMessageAntispamConfig() {
        this(DEFAULT_ANTISPAM_ENABLED, null, null, null, null);
    }

    private V2NIMMessageAntispamConfig(boolean antispamEnabled, String antispamBusinessId, String antispamCustomMessage, String antispamCheating, String antispamExtension) {
        this.antispamEnabled = antispamEnabled;
        this.antispamBusinessId = antispamBusinessId;
        this.antispamCustomMessage = antispamCustomMessage;
        this.antispamCheating = antispamCheating;
        this.antispamExtension = antispamExtension;
    }

    public boolean isAntispamEnabled() {
        return antispamEnabled;
    }

    public String getAntispamBusinessId() {
        return antispamBusinessId;
    }

    public String getAntispamCustomMessage() {
        return antispamCustomMessage;
    }

    public String getAntispamCheating() {
        return antispamCheating;
    }

    public String getAntispamExtension() {
        return antispamExtension;
    }

    @Override
    public String toString() {
        return "V2NIMMessageAntispamConfig{" +
                "antispamEnabled=" + antispamEnabled +
                ", antispamBusinessId='" + antispamBusinessId + '\'' +
                ", antispamCustomMessage='" + antispamCustomMessage + '\'' +
                ", antispamCheating='" + antispamCheating + '\'' +
                ", antispamExtension='" + antispamExtension + '\'' +
                '}';
    }

    private final static boolean DEFAULT_ANTISPAM_ENABLED = true;

    public static final class V2NIMMessageAntispamConfigBuilder {
        private boolean antispamEnabled = DEFAULT_ANTISPAM_ENABLED;
        private String antispamBusinessId;
        private String antispamCustomMessage;
        private String antispamCheating;
        private String antispamExtension;

        private V2NIMMessageAntispamConfigBuilder() {
        }

        public static V2NIMMessageAntispamConfigBuilder builder() {
            return new V2NIMMessageAntispamConfigBuilder();
        }

        public V2NIMMessageAntispamConfigBuilder withAntispamEnabled(boolean antispamEnabled) {
            this.antispamEnabled = antispamEnabled;
            return this;
        }

        public V2NIMMessageAntispamConfigBuilder withAntispamBusinessId(String antispamBusinessId) {
            this.antispamBusinessId = antispamBusinessId;
            return this;
        }

        public V2NIMMessageAntispamConfigBuilder withAntispamCustomMessage(String antispamCustomMessage) {
            this.antispamCustomMessage = antispamCustomMessage;
            return this;
        }

        public V2NIMMessageAntispamConfigBuilder withAntispamCheating(String antispamCheating) {
            this.antispamCheating = antispamCheating;
            return this;
        }

        public V2NIMMessageAntispamConfigBuilder withAntispamExtension(String antispamExtension) {
            this.antispamExtension = antispamExtension;
            return this;
        }

        public V2NIMMessageAntispamConfig build() {
            return new V2NIMMessageAntispamConfig(antispamEnabled, antispamBusinessId, antispamCustomMessage, antispamCheating, antispamExtension);
        }
    }
}