V2NIMSendMessageParams.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageAntispamConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessagePushConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageRobotConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageRouteConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageTargetConfig;

public class V2NIMSendMessageParams {
    /**
     * 消息相关配置
     */
    private final V2NIMMessageConfig messageConfig;

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

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

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

    /**
     * 机器人相关配置
     */
    private final V2NIMMessageRobotConfig robotConfig;
    /**
     * 请求大模型的相关参数
     */
    private final V2NIMMessageAIConfigParams    aiConfig;
    /**
     * 定向消息相关配置
     * 用以控制在发送群组消息时，消息是否发送给指定的群组成员
     */
    private final V2NIMMessageTargetConfig targetConfig;

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

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

    private V2NIMSendMessageParams() {
        this(
                null,
                null,
                null,
                null,
                null,
                null,
                null,
                DEFAULT_CLIENT_ANTISPAM_ENABLED,
                DEFAULT_CLIENT_ANTISPAM_REPLACE);
    }

    private V2NIMSendMessageParams(V2NIMMessageConfig messageConfig, V2NIMMessageRouteConfig routeConfig, V2NIMMessagePushConfig pushConfig, V2NIMMessageAntispamConfig antispamConfig, V2NIMMessageRobotConfig robotConfig,V2NIMMessageAIConfigParams aiConfig, V2NIMMessageTargetConfig targetConfig, boolean clientAntispamEnabled, String clientAntispamReplace) {
        this.messageConfig = messageConfig;
        this.routeConfig = routeConfig;
        this.pushConfig = pushConfig;
        this.antispamConfig = antispamConfig;
        this.robotConfig = robotConfig;
        this.aiConfig = aiConfig;
        this.targetConfig = targetConfig;
        this.clientAntispamEnabled = clientAntispamEnabled;
        this.clientAntispamReplace = clientAntispamReplace;
    }
    /**
     * 获取消息相关配置
     * @return 消息相关配置
     */
    public V2NIMMessageConfig getMessageConfig() {
        return messageConfig;
    }
    /**
     * 获取路由相关配置
     * @return 路由相关配置
     */
    public V2NIMMessageRouteConfig getRouteConfig() {
        return routeConfig;
    }
    /**
     * 获取推送相关配置
     * @return 推送相关配置
     */
    public V2NIMMessagePushConfig getPushConfig() {
        return pushConfig;
    }
    /**
     * 获取反垃圾相关配置
     * @return 反垃圾相关配置
     */
    public V2NIMMessageAntispamConfig getAntispamConfig() {
        return antispamConfig;
    }
    /**
     * 获取机器人相关配置
     * @return 机器人相关配置
     */
    public V2NIMMessageRobotConfig getRobotConfig() {
        return robotConfig;
    }
    /**
     * 获取请求大模型的相关参数
     * @return 请求大模型的相关参数
     */
    public V2NIMMessageAIConfigParams getAIConfig() {
        return aiConfig;
    }
    /**
     * 获取定向消息相关配置
     * @return 定向消息相关配置
     */
    public V2NIMMessageTargetConfig getTargetConfig() {
        return targetConfig;
    }
    /**
     * 获取是否启用本地反垃圾
     * @return 是否启用本地反垃圾
     */
    public boolean isClientAntispamEnabled() {
        return clientAntispamEnabled;
    }
    /**
     * 获取反垃圾命中后替换的文本
     * @return 反垃圾命中后替换的文本
     */
    public String getClientAntispamReplace() {
        return clientAntispamReplace;
    }

    @Override
    public String toString() {
        return "V2NIMSendMessageParams{" +
                "messageConfig=" + messageConfig +
                ", routeConfig=" + routeConfig +
                ", pushConfig=" + pushConfig +
                ", antispamConfig=" + antispamConfig +
                ", robotConfig=" + robotConfig +
                ", clientAntispamEnabled=" + clientAntispamEnabled +
                ", clientAntispamReplace='" + clientAntispamReplace + '\'' +
                '}';
    }

    private final static boolean DEFAULT_CLIENT_ANTISPAM_ENABLED = false;
    private final static String DEFAULT_CLIENT_ANTISPAM_REPLACE = "";

    /**
     * Builder for {@link V2NIMSendMessageParams}
     */
    public static final class V2NIMSendMessageParamsBuilder {
        private V2NIMMessageConfig messageConfig;
        private V2NIMMessageRouteConfig routeConfig;
        private V2NIMMessagePushConfig pushConfig;
        private V2NIMMessageAntispamConfig antispamConfig;
        private V2NIMMessageRobotConfig robotConfig;
        private V2NIMMessageAIConfigParams aiConfig;
        private V2NIMMessageTargetConfig targetConfig;
        private boolean clientAntispamEnabled = DEFAULT_CLIENT_ANTISPAM_ENABLED;
        private String clientAntispamReplace = DEFAULT_CLIENT_ANTISPAM_REPLACE;

        private V2NIMSendMessageParamsBuilder() {
        }

        /**
         * Create a new {@link V2NIMSendMessageParamsBuilder} instance
         * @return
         */
        public static V2NIMSendMessageParamsBuilder builder() {
            return new V2NIMSendMessageParamsBuilder();
        }

        /**
         * Set the message config
         * @param messageConfig the message config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withMessageConfig(V2NIMMessageConfig messageConfig) {
            this.messageConfig = messageConfig;
            return this;
        }

        /**
         * Set the route config
         * @param routeConfig the route config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withRouteConfig(V2NIMMessageRouteConfig routeConfig) {
            this.routeConfig = routeConfig;
            return this;
        }
        /**
         * Set the push config
         * @param pushConfig the push config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withPushConfig(V2NIMMessagePushConfig pushConfig) {
            this.pushConfig = pushConfig;
            return this;
        }
        /**
         * Set the antispam config
         * @param antispamConfig the antispam config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withAntispamConfig(V2NIMMessageAntispamConfig antispamConfig) {
            this.antispamConfig = antispamConfig;
            return this;
        }
        /**
         * Set the robot config
         * @param robotConfig the robot config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withRobotConfig(V2NIMMessageRobotConfig robotConfig) {
            this.robotConfig = robotConfig;
            return this;
        }
        /**
         * Set the client antispam enabled
         * @param clientAntispamEnabled the client antispam enabled
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withClientAntispamEnabled(boolean clientAntispamEnabled) {
            this.clientAntispamEnabled = clientAntispamEnabled;
            return this;
        }
        /**
         * Set the client antispam replace
         * @param clientAntispamReplace the client antispam replace
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withClientAntispamReplace(String clientAntispamReplace) {
            this.clientAntispamReplace = clientAntispamReplace;
            return this;
        }
        /**
         * Set the AI config
         * @param aiConfig the AI config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withAIConfig(V2NIMMessageAIConfigParams aiConfig) {
            this.aiConfig = aiConfig;
            return this;
        }
        /**
         * Set the target config
         * @param targetConfig the target config
         * @return V2NIMSendMessageParamsBuilder
         */
        public V2NIMSendMessageParamsBuilder withTargetConfig(V2NIMMessageTargetConfig targetConfig) {
            this.targetConfig = targetConfig;
            return this;
        }

        public V2NIMSendMessageParams build() {
            return new V2NIMSendMessageParams(messageConfig, routeConfig, pushConfig, antispamConfig, robotConfig,aiConfig,targetConfig, clientAntispamEnabled, clientAntispamReplace);
        }
    }
}