V2NIMSendChatroomMessageParams.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.chatroom.config.V2NIMChatroomMessageConfig;
import com.netease.nimlib.sdk.v2.chatroom.model.V2NIMLocationInfo;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageAntispamConfig;
import com.netease.nimlib.sdk.v2.message.config.V2NIMMessageRouteConfig;
import java.io.Serializable;
import java.util.List;

/**
 * 发送聊天室消息相关配置
 */
public class V2NIMSendChatroomMessageParams implements Serializable {

    /**
     * 消息相关配置
     */
    private V2NIMChatroomMessageConfig messageConfig;
    /**
     * 路由抄送相关配置
     */
    private V2NIMMessageRouteConfig    routeConfig;
    /**
     * 反垃圾相关配置
     */
    private V2NIMMessageAntispamConfig antispamConfig;
    /**
     * 是否启用本地反垃圾,默认false
     */
    private Boolean clientAntispamEnabled;
    /**
     * 反垃圾命中后替换的文本
     */
    private String       clientAntispamReplace;
    /**
     * 聊天室定向消息接收者账号ID列表，如果receiverIds不为空，表示为聊天室定向消息， 设置该字段后， 会忽略消息配置中的history_enabled配置， 消息不存历史
     */
    private List<String> receiverIds;
    /**
     * 消息的目标标签表达式
     */
    private String notifyTargetTags;
    /**
     * 位置信息
     */
    private V2NIMLocationInfo locationInfo;

    public V2NIMSendChatroomMessageParams() {
    }

    /**
     * 获取消息相关配置
     * @return 消息相关配置
     */
    public V2NIMChatroomMessageConfig getMessageConfig() {
        return messageConfig;
    }
    /**
     * 设置消息相关配置
     * @param messageConfig 消息相关配置
     */
    public void setMessageConfig(V2NIMChatroomMessageConfig messageConfig) {
        this.messageConfig = messageConfig;
    }

    /**
     * 获取路由抄送相关配置
     * @return 路由抄送相关配置
     */
    public V2NIMMessageRouteConfig getRouteConfig() {
        return routeConfig;
    }

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

    /**
     * 获取反垃圾相关配置
     * @return 反垃圾相关配置
     */
    public V2NIMMessageAntispamConfig getAntispamConfig() {
        return antispamConfig;
    }

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

    /**
     * 获取是否启用本地反垃圾,默认false
     * @return 是否启用本地反垃圾,默认false
     */
    public boolean isClientAntispamEnabled() {
        if (clientAntispamEnabled == null) {
            return false;
        }
        return clientAntispamEnabled;
    }

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

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

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

    /**
     * 获取聊天室定向消息接收者账号ID列表，如果receiverIds不为空，表示为聊天室定向消息， 设置该字段后， 会忽略消息配置中的history_enabled配置， 消息不存历史
     * @return 聊天室定向消息接收者账号ID列表
     */
    public List<String> getReceiverIds() {
        return receiverIds;
    }

    /**
     * 设置聊天室定向消息接收者账号ID列表，如果receiverIds不为空，表示为聊天室定向消息， 设置该字段后， 会忽略消息配置中的history_enabled配置， 消息不存历史
     * @param receiverIds 聊天室定向消息接收者账号ID列表
     */
    public void setReceiverIds(List<String> receiverIds) {
        this.receiverIds = receiverIds;
    }

    /**
     * 获取消息的目标标签表达式
     * @return 消息的目标标签表达式
     */
    public String getNotifyTargetTags() {
        return notifyTargetTags;
    }

    /**
     * 设置消息的目标标签表达式
     * @param notifyTargetTags 消息的目标标签表达式
     */
    public void setNotifyTargetTags(String notifyTargetTags) {
        this.notifyTargetTags = notifyTargetTags;
    }

    /**
     * 获取位置信息
     * @return 位置信息
     */
    public V2NIMLocationInfo getLocationInfo() {
        return locationInfo;
    }

    /**
     * 设置位置信息
     * @param locationInfo 位置信息
     */
    public void setLocationInfo(V2NIMLocationInfo locationInfo) {
        this.locationInfo = locationInfo;
    }
}