V2NIMMessageTargetConfig.java

浏览该文件的文档.

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

import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.util.CollectionUtil;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

public class V2NIMMessageTargetConfig implements Serializable {

    /**
     * true 表示消息发送到群组中 receiverIds 对应的成员， false 表示消息发送到群组中排除 receiverIds 以外的所有成员。
     * <p>
     * 当发送的消息会话类型为超级群时不允许设置该字段为 false
     */
    private boolean      inclusive        = true;
    /**
     * 消息接收者ID列表
     */
    private List<String> receiverIds;
    /**
     * 新成员是否可以查看该定向消息
     */
    private boolean      newMemberVisible = false;

    public V2NIMMessageTargetConfig() {
    }

    /**
     *
     * @param receiverIds 消息接收者ID列表
     */
    public V2NIMMessageTargetConfig(List<String> receiverIds) {
        setReceiverIds(receiverIds);
    }

    /**
     *
     * @param inclusive true 表示消息发送到群组中 receiverIds 对应的成员， false 表示消息发送到群组中排除 receiverIds 以外的所有成员。
     *                  当发送的消息会话类型为超级群时不允许设置该字段为 false
     * @param receiverIds 消息接收者ID列表
     * @param newMemberVisible 新成员是否可以查看该定向消息
     */
    public V2NIMMessageTargetConfig(boolean inclusive, List<String> receiverIds, boolean newMemberVisible) {
        this(receiverIds);
        this.inclusive = inclusive;
        this.newMemberVisible = newMemberVisible;
    }

    /**
     * 获取inclusive字段的值
     * @return inclusive字段的值，true 表示消息发送到群组中 receiverIds 对应的成员， false 表示消息发送到群组中排除 receiverIds 以外的所有成员。
     * 当发送的消息会话类型为超级群时不允许设置该字段为 false
     */
    public boolean isInclusive() {
        return this.inclusive;
    }

    /**
     * 设置inclusive字段的值
     * @param inclusive 新的inclusive字段的值，true 表示消息发送到群组中 receiverIds 对应的成员， false 表示消息发送到群组中排除 receiverIds 以外的所有成员。
     * 当发送的消息会话类型为超级群时不允许设置该字段为 false
     */
    public void setInclusive(boolean inclusive) {
        this.inclusive = inclusive;
    }

    /**
     * 获取receiverIds字段的值
     * @return receiverIds字段的值，消息接收者ID列表
     */
    public List<String> getReceiverIds() {
        return this.receiverIds;
    }

    /**
     * 设置receiverIds字段的值
     * @param receiverIds 新的receiverIds字段的值，消息接收者ID列表
     */
    public void setReceiverIds(List<String> receiverIds) {
        if(CollectionUtil.isEmpty(receiverIds)) {
            this.receiverIds = null;
        }else{
            this.receiverIds = new ArrayList<>(receiverIds.size());
            for(String id : receiverIds){
                if(id != null && !id.isEmpty() && !id.equals(SDKCacheUI.getAccount())){
                    this.receiverIds.add(id);
                }
            }
        }
    }

    /**
     * 获取newMemberVisible字段的值
     * @return newMemberVisible字段的值，新成员是否可以查看该定向消息
     */
    public boolean isNewMemberVisible() {
        return this.newMemberVisible;
    }

    /**
     * 设置newMemberVisible字段的值
     * @param newMemberVisible 新的newMemberVisible字段的值，新成员是否可以查看该定向消息
     */
    public void setNewMemberVisible(boolean newMemberVisible) {
        this.newMemberVisible = newMemberVisible;
    }
    /**
     * 判断当前对象是否有效
     * @return 当前对象是否有效
     */
    public boolean isValid() {
        // receiverIds 不能为空
        if(CollectionUtil.isEmpty(receiverIds)){
            return false;
        }
        return true;
    }

    public String getInvalidMsg() {
        if(receiverIds == null){
            return "receiverIds is null";
        }else if(receiverIds.isEmpty()){
            return "receiverIds is empty";
        }
        return null;
    }

}