EnterChatRoomData.java

浏览该文件的文档.

package com.netease.nimlib.sdk.chatroom.model;

import android.text.TextUtils;

import com.netease.nimlib.abtest.ABTestConfigHelper;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.antispam.model.AntiSpamConfig;
import java.util.Map;

/**
 * Created by huangjun on 2015/12/28.
 */
public class EnterChatRoomData {

    private static final String TAG = "EnterChatRoomData";

    private String roomId; // 必填,聊天室ID

    private boolean enableLbs; // 启用LBS，默认false

    /*
     * 独立模式
     */
    private boolean independentMode; // 是否是独立模式登录，默认为false，需要依赖IM登录。独立模式可以不依赖IM登录。
    /**
     * 是否匿名模式
     */
    private boolean isAnonymousMode;

    /**
     * 独立登录模式下，才启用
     */
    private String appKey; // 聊天室可以使用独立的appkey， 不依赖于im appkey， 如果不传，则使用im appkey，

    private String account; // 登录用户名，不填则表示匿名

    private String token; // 登录token

    private ChatRoomIndependentCallback independentModeCallback; // 独立模式的回调

    /*
     * 可选字段,如果不填则直接使用NimUserInfo的数据
     */
    private String nick;                  // 进入聊天室后展示的昵称

    private String avatar;                // 进入聊天室后展示的头像

    private Map<String, Object> extension;             // 进入聊天室后展示的扩展字段，长度限制4K

    private Map<String, Object> notifyExtension;       // 进入聊天室通知开发者扩展字段，长度限制2K

    private String tags;                    // 登录标签，可以设置多个，json_array格式，例子：["tag1", "tag2"]

    private String notifyTargetTags;        // 登录登出通知的目标标签，是一个标签表达式，见TagCalculator和TagPattern
    /**
     * 反垃圾配置参数
     */
    private AntiSpamConfig antiSpamConfig;

    private Integer loginAuthType;       //鉴权方式，0表示最初的loginToken的校验方式，1表示基于appSecret计算的token鉴权方式，2表示基于第三方回调的token鉴权方式，默认0

    private String loginExt;            //登录自定义字段，用于提交给用户的第三方回调服务进行登录检测

    private ChatRoomSpatialLocation chatRoomSpatialLocation;      //空间位置信息
    /**
     * loginAuthType=1时必须要设置
     * @Deprecated 请使用 SDKOptions.ChatRoomAuthProvider
     */
    @Deprecated
    private ChatRoomAuthProvider chatRoomAuthProvider;//动态token提供回调

    /**
     * 获取聊天室id
     *
     * @return
     */
    public String getRoomId() {
        return roomId;
    }

    /**
     * 设置聊天室id
     *
     * @param roomId
     */
    public void setRoomId(String roomId) {
        this.roomId = roomId;
    }

    public boolean isEnableLbs() {
        String abTestConfig = ABTestConfigHelper.getChatRoomLinkConfig();
        if (TextUtils.isEmpty(abTestConfig)) {
            return enableLbs;
        } else {
            NimLog.w(TAG, "abTestConfig as isEnableLbs: " + abTestConfig);
            return true;
        }
    }

    public void setEnableLbs(boolean enableLbs) {
        this.enableLbs = enableLbs;
    }

    /**
     * 兼容旧接口，enableLbs 只控制是否通过 LBS 获取聊天室链路。
     * account/token/isAnonymousMode 仅在独立模式下才会生效。
     */
    public void setEnableLbs(boolean enableLbs, String account, String token, boolean isAnonymousMode) {
        this.enableLbs = enableLbs;
        if (independentMode) {
            setIndependentModeInternal(account, token, isAnonymousMode);
        }
    }

    /**
     * 获取聊天室appKey
     *
     * @return
     */
    public String getAppKey() {
        return appKey;
    }

    /**
     * 设置聊天室appKey，独立登录模式下，才启用， 不传则使用IM对应的appKey， 需要保证roomId与appKey的对应关系
     *
     * @param appKey
     */
    public void setAppKey(String appKey) {
        this.appKey = appKey;
    }

    /**
     * 获取聊天室展示的昵称
     *
     * @return
     */
    public String getNick() {
        return nick;
    }

    /**
     * 设置聊天室展示的昵称，可选字段，如果不填则直接使用NimUserInfo的数据
     *
     * @param nick
     */
    public void setNick(String nick) {
        this.nick = nick;
    }

    /**
     * 获取聊天室展示的头像
     *
     * @return
     */
    public String getAvatar() {
        return avatar;
    }

    /**
     * 设置聊天室展示的头像
     *
     * @param avatar
     */
    public void setAvatar(String avatar) {
        this.avatar = avatar;
    }

    /**
     * 获取进入聊天室后展示的扩展字段
     *
     * @return
     */
    public Map<String, Object> getExtension() {
        return extension;
    }

    /**
     * 设置进入聊天室后展示的扩展字段，长度限制4k
     *
     * @param extension
     */
    public void setExtension(Map<String, Object> extension) {
        this.extension = extension;
    }

    /**
     * 获取聊天室通知开发者扩展字段
     *
     * @return
     */
    public Map<String, Object> getNotifyExtension() {
        return notifyExtension;
    }

    /**
     * 设置聊天室通知开发者扩展字段，长度限制1k
     *
     * @param notifyExtension
     */
    public void setNotifyExtension(Map<String, Object> notifyExtension) {
        this.notifyExtension = notifyExtension;
    }

    /**
      * 获取 登录标签
      * @return
     */
    public String getTags() {
        return tags;
    }

    /**
     * 设置 登录标签
     * @param tags
     */
    public void setTags(String tags) {
        this.tags = tags;
    }

    /**
     * 获取 登录登出通知的目标标签
     * @return
     */
    public String getNotifyTargetTags() {
        return notifyTargetTags;
    }

    /**
     * 设置 登录登出通知的目标标签
     * @param notifyTargetTags
     */
    public void setNotifyTargetTags(String notifyTargetTags) {
        this.notifyTargetTags = notifyTargetTags;
    }

    /**
     * 是否是独立登录聊天室
     *
     * @return false，需要IM先登录才可以进入聊天室。true，不需要依赖IM，支持匿名登录，实际账号密码登录。
     */
    public boolean isIndependentMode() {
        return independentMode;
    }

    public boolean isAnonymousMode() {
        return isAnonymousMode;
    }

    /**
     * 获取独立登录模式的用户账号
     *
     * @return 账号，null表示匿名登录
     */
    public String getAccount() {
        return account;
    }

    /**
     * 获取独立登录模式的用户密码
     *
     * @return 登录口令
     */
    public String getToken() {
        return token;
    }

    /**
     * 获取鉴权方式
     * @return
     */
    public Integer getLoginAuthType() {
        return loginAuthType;
    }

    /**
     * 设置鉴权方式
     * @param loginAuthType
     */
    public void setLoginAuthType(Integer loginAuthType) {
        this.loginAuthType = loginAuthType;
    }

    /**
     * 获取登录自定义字段
     * @return
     */
    public String getLoginExt() {
        return loginExt;
    }

    /**
     * 设置登录自定义字段
     * @param loginExt
     */
    public void setLoginExt(String loginExt) {
        this.loginExt = loginExt;
    }

    public ChatRoomSpatialLocation getChatRoomSpatialLocation() {
        return chatRoomSpatialLocation;
    }

    public void setChatRoomSpatialLocation(ChatRoomSpatialLocation chatRoomSpatialLocation) {
        this.chatRoomSpatialLocation = chatRoomSpatialLocation;
    }

    @Deprecated
    public ChatRoomAuthProvider getChatRoomAuthProvider() {
        return chatRoomAuthProvider;
    }

    @Deprecated
    public void setChatRoomAuthProvider(
        ChatRoomAuthProvider chatRoomAuthProvider) {
        this.chatRoomAuthProvider = chatRoomAuthProvider;
    }

    public ChatRoomIndependentCallback getIndependentModeCallback() {
        return independentModeCallback;
    }

    public AntiSpamConfig getAntiSpamConfig() {
        return antiSpamConfig;
    }

    public void setAntiSpamConfig(AntiSpamConfig antiSpamConfig) {
        this.antiSpamConfig = antiSpamConfig;
    }

    /**
     * 设置聊天室独立模式
     *
     * @param cb      如果是独立模式，必须提供回调函数，用于SDK向APP获取聊天室地址信息的数据。
     * @param account 独立登录的账号，可以不填。不填即为匿名登录
     * @param token   独立登录的密码。
     */
    public void setIndependentMode(ChatRoomIndependentCallback cb, String account, String token) {
        this.independentMode = true;
        this.independentModeCallback = cb;
        setIndependentModeInternal(account, token, TextUtils.isEmpty(account));
    }

    protected void setIndependentModeInternal(String account, String token, boolean isAnonymousMode) {
        this.account = account;
        this.token = token;
        this.isAnonymousMode = isAnonymousMode;
    }

    /**
     * 设置聊天室独立模式
     *
     * @param cb              如果是独立模式，必须提供回调函数，用于SDK向APP获取聊天室地址信息的数据。
     * @param account         独立登录的账号，
     * @param token           独立登录的密码。
     * @param isAnonymousMode 是否匿名模式，如果为false，account参数不可为空
     */
    public void setIndependentMode(ChatRoomIndependentCallback cb, String account, String token,boolean isAnonymousMode) {
        this.independentMode = true;
        this.independentModeCallback = cb;
        setIndependentModeInternal(account, token, isAnonymousMode);
    }

    public EnterChatRoomData(String roomId) {
        this.roomId = roomId;
    }

    public boolean isValid() {
        if (TextUtils.isEmpty(roomId)) {
            return false;
        }
        try {
            Long.parseLong(roomId);
            return true;
        } catch (NumberFormatException e) {
            return false;
        }
    }
}