V2NIMChatroomEnterParams.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.chatroom.config.V2NIMChatroomLocationConfig;
import com.netease.nimlib.sdk.v2.chatroom.config.V2NIMChatroomTagConfig;
import com.netease.nimlib.sdk.v2.chatroom.option.V2NIMChatroomLoginOption;
import com.netease.nimlib.sdk.v2.chatroom.provider.V2NIMChatroomLinkProvider;
import com.netease.nimlib.sdk.v2.common.V2NIMAntispamConfig;

import java.io.Serializable;

/**
 * 加入聊天室登录相关参数
 */
public class V2NIMChatroomEnterParams implements Serializable {

    /**
     * 是否匿名模式
     * 匿名模式不能发消息， 只能收消息
     */
    private final boolean anonymousMode;

    /**
     * 是否启用聊天室LBS
     */
    private final boolean enableLbs;

    /**
     * 账号ID
     *  如果是匿名， 可以不填，内部生成账号
     *      规则：nimanon_ UUID.randomUUID().toString(), 建议全局缓存一个
     *  否则必须是合法的账号
     */

    private final String accountId;

    /**
     * 静态token
     * 快速使用接口， 方便用户使用，可以不填
     */
    private final String token;


    /**
     * 进入聊天室后显示的昵称
     * 如果填写则使用填写的内容
     * 否则使用账号对应相关信息
     * 如果是匿名模式，默认昵称为账号名称
     */
    private final String roomNick;

    /**
     * 进入聊天室后显示的头像
     * 如果填写则使用填写的内容
     * 否则使用账号对应相关信息
     * 如果为匿名模式，默认头像为空，如果需要头像，上传可以采用：SDK-API存储服务设计文档 uploadFile
     */
    private final String roomAvatar;

    /**
     * 进入方法超时时间
     * 超过该时间如果没有进入成功， 则返回失败
     */
    private final int timeout;

    /**
     * 聊天室登录相关信息
     */
    private final V2NIMChatroomLoginOption loginOption;

    /**
     * 获取聊天室link链接地址， 两种获取途径
     * 如果IM已经登录且在线， 可以采用V2NIMLoginService.getChatroomLinkAddress 方法获取（用IM的长连接发送 13-1）note：新增接口
     * 由客户代理实现，请求业务服务器，由业务服务器请求云信OpenApi获得
     */
    private final V2NIMChatroomLinkProvider linkProvider;

    /**
     * 用户扩展字段，建议使用json格式
     */
    private final String serverExtension;

    /**
     * 通知扩展字段，进入聊天室通知开发者扩展字段
     */
    private final String notificationExtension;

    /**
     * 进入聊天室标签信息配置
     */
    private final V2NIMChatroomTagConfig tagConfig;

    /**
     * 进入聊天室空间位置信息配置
     */
    private final V2NIMChatroomLocationConfig locationConfig;


    /**
     * 用户资料反垃圾检测
     * 如果不审核，该配置不需要配置
     * 如果开启了安全通，默认采用安全通，该配置不需要配置
     * 如果需要审核，且直接对接易盾，则配置该配置
     */
    private final V2NIMAntispamConfig antispamConfig;

    private V2NIMChatroomEnterParams() {
        this(false, false, null, null, null, null, TIMEOUT_DEFAULT, null, null, null, null, null, null, null);
    }

    public V2NIMChatroomEnterParams(boolean anonymousMode, boolean enableLbs, String accountId, String token, String roomNick, String roomAvatar, int timeout, V2NIMChatroomLoginOption loginOption, V2NIMChatroomLinkProvider linkProvider, String serverExtension, String notificationExtension, V2NIMChatroomTagConfig tagConfig, V2NIMChatroomLocationConfig locationConfig, V2NIMAntispamConfig antispamConfig) {
        this.anonymousMode = anonymousMode;
        this.enableLbs = enableLbs;
        this.accountId = accountId;
        this.token = token;
        this.roomNick = roomNick;
        this.roomAvatar = roomAvatar;
        this.timeout = timeout;
        this.loginOption = loginOption;
        this.linkProvider = linkProvider;
        this.serverExtension = serverExtension;
        this.notificationExtension = notificationExtension;
        this.tagConfig = tagConfig;
        this.locationConfig = locationConfig;
        this.antispamConfig = antispamConfig;
    }
    /**
     * 获取是否匿名模式
     * @return 是否匿名模式
     */
    public boolean isAnonymousMode() {
        return anonymousMode;
    }

    public boolean isEnableLbs() {
        return enableLbs;
    }

    /**
     * 获取账号ID
     * @return 账号ID
     */
    public String getAccountId() {
        return accountId;
    }
    /**
     * 获取静态token
     * @return 静态token
     */
    public String getToken() {
        return token;
    }
    /**
     * 获取进入聊天室后显示的昵称
     * @return 进入聊天室后显示的昵称
     */
    public String getRoomNick() {
        return roomNick;
    }
    /**
     * 获取进入聊天室后显示的头像
     * @return 进入聊天室后显示的头像
     */
    public String getRoomAvatar() {
        return roomAvatar;
    }
    /**
     * 获取进入方法超时时间
     * @return 进入方法超时时间
     */
    public int getTimeout() {
        return timeout;
    }
    /**
     * 获取聊天室登录相关信息
     * @return 聊天室登录相关信息
     */
    public V2NIMChatroomLoginOption getLoginOption() {
        if (loginOption == null) {
            return V2NIMChatroomLoginOption.V2NIMChatroomLoginOptionBuilder.builder().build();
        } else {
            return loginOption;
        }
    }
    /**
     * 获取获取聊天室link链接地址， 两种获取途径
     * @return 获取聊天室link链接地址， 两种获取途径
     */
    public V2NIMChatroomLinkProvider getLinkProvider() {
        return linkProvider;
    }
    /**
     * 获取用户扩展字段，建议使用json格式
     * @return 用户扩展字段，建议使用json格式
     */
    public String getServerExtension() {
        return serverExtension;
    }
    /**
     * 获取通知扩展字段，进入聊天室通知开发者扩展字段
     * @return 通知扩展字段，进入聊天室通知开发者扩展字段
     */
    public String getNotificationExtension() {
        return notificationExtension;
    }
    /**
     * 获取进入聊天室标签信息配置
     * @return 进入聊天室标签信息配置
     */
    public V2NIMChatroomTagConfig getTagConfig() {
        return tagConfig;
    }
    /**
     * 获取进入聊天室空间位置信息配置
     * @return 进入聊天室空间位置信息配置
     */
    public V2NIMChatroomLocationConfig getLocationConfig() {
        return locationConfig;
    }
    /**
     * 获取用户资料反垃圾检测
     * @return 用户资料反垃圾检测
     */
    public V2NIMAntispamConfig getAntispamConfig() {
        return antispamConfig;
    }

    @Override
    public String toString() {
        return "V2NIMChatroomEnterParams{" +
                "anonymousMode=" + anonymousMode +
                ", enableLbs='" + enableLbs + '\'' +
                ", accountId='" + accountId + '\'' +
                ", token='" + token + '\'' +
                ", roomNick='" + roomNick + '\'' +
                ", roomAvatar='" + roomAvatar + '\'' +
                ", timeout=" + timeout +
                ", loginOption=" + loginOption +
                ", linkProvider=" + linkProvider +
                ", serverExtension='" + serverExtension + '\'' +
                ", notificationExtension='" + notificationExtension + '\'' +
                ", tagConfig=" + tagConfig + '\'' +
                ", locationConfig=" + locationConfig + '\'' +
                ", antispamConfig=" + antispamConfig + '\'' +
                '}';
    }

    private static final int TIMEOUT_DEFAULT = 60;

    /**
     * {@link V2NIMChatroomEnterParams}构造器
     */
    public static final class V2NIMChatroomEnterParamsBuilder {

        /**
         * 聊天室登录相关信息
         */
        private V2NIMChatroomLoginOption loginOption;
        /**
         * 获取聊天室link链接地址， 两种获取途径
         * 如果IM已经登录且在线， 可以采用V2NIMLoginService.getChatroomLinkAddress 方法获取（用IM的长连接发送 13-1）note：新增接口
         * 由客户代理实现，请求业务服务器，由业务服务器请求云信OpenApi获得
         */
        private final V2NIMChatroomLinkProvider linkProvider;
        /**
         * 是否匿名模式
         * 匿名模式不能发消息， 只能收消息
         */
        private boolean anonymousMode;
        /**
         * 账号ID
         */
        private String accountId;
        /**
         * 静态token
         */
        private String token;
        /**
         * 进入聊天室后显示的昵称
         */
        private String roomNick;
        /**
         * 进入聊天室后显示的头像
         */
        private String roomAvatar;
        /**
         * 进入方法超时时间
         */
        private int timeout = TIMEOUT_DEFAULT;
        /**
         * 用户扩展字段，建议使用json格式
         */
        private String serverExtension;
        /**
         * 通知扩展字段，进入聊天室通知开发者扩展字段
         */
        private String notificationExtension;
        /**
         * 进入聊天室标签信息配置
         */
        private V2NIMChatroomTagConfig tagConfig;
        /**
         * 进入聊天室空间位置信息配置
         */
        private V2NIMChatroomLocationConfig locationConfig;
        /**
         * 用户资料反垃圾检测
         */
        private V2NIMAntispamConfig antispamConfig;
        /**
         * 是否启用聊天室LBS
         */
        private boolean enableLbs;

        private V2NIMChatroomEnterParamsBuilder(V2NIMChatroomLinkProvider linkProvider) {
            this.linkProvider = linkProvider;
        }

        /**
         *
         * @param linkProvider 获取聊天室link链接地址， 两种获取途径
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public static V2NIMChatroomEnterParamsBuilder builder(V2NIMChatroomLinkProvider linkProvider) {
            return new V2NIMChatroomEnterParamsBuilder(linkProvider);
        }

        /**
         * 设置聊天室登录相关信息
         * @param loginOption 聊天室登录相关信息
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withLoginOption(V2NIMChatroomLoginOption loginOption) {
            this.loginOption = loginOption;
            return this;
        }

        /**
         * 设置是否匿名模式
         * @param anonymousMode 是否匿名模式
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withAnonymousMode(boolean anonymousMode) {
            this.anonymousMode = anonymousMode;
            return this;
        }

        /**
         * 设置是否启用聊天室LBS
         * @param enableLbs 是否启用聊天室LBS
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withEnableLbs(boolean enableLbs) {
            this.enableLbs = enableLbs;
            return this;
        }

        /**
         * 设置账号ID
         * @param accountId 账号ID
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withAccountId(String accountId) {
            this.accountId = accountId;
            return this;
        }

        /**
         * 设置静态token
         * @param token 静态token
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withToken(String token) {
            this.token = token;
            return this;
        }

        /**
         * 设置进入聊天室后显示的昵称
         * @param roomNick 进入聊天室后显示的昵称
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withRoomNick(String roomNick) {
            this.roomNick = roomNick;
            return this;
        }

        /**
         * 设置进入聊天室后显示的头像
         * @param roomAvatar 进入聊天室后显示的头像
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withRoomAvatar(String roomAvatar) {
            this.roomAvatar = roomAvatar;
            return this;
        }

        /**
         * 设置进入方法超时时间
         * @param timeout 进入方法超时时间
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withTimeout(int timeout) {
            this.timeout = timeout;
            return this;
        }

        /**
         * 设置用户扩展字段，建议使用json格式
         * @param serverExtension 用户扩展字段，建议使用json格式
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withServerExtension(String serverExtension) {
            this.serverExtension = serverExtension;
            return this;
        }

        /**
         * 设置通知扩展字段，进入聊天室通知开发者扩展字段
         * @param notificationExtension 通知扩展字段，进入聊天室通知开发者扩展字段
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withNotificationExtension(String notificationExtension) {
            this.notificationExtension = notificationExtension;
            return this;
        }

        /**
         * 设置进入聊天室标签信息配置
         * @param tagConfig 进入聊天室标签信息配置
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withTagConfig(V2NIMChatroomTagConfig tagConfig) {
            this.tagConfig = tagConfig;
            return this;
        }

        /**
         * 设置进入聊天室空间位置信息配置
         * @param locationConfig 进入聊天室空间位置信息配置
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withLocationConfig(V2NIMChatroomLocationConfig locationConfig) {
            this.locationConfig = locationConfig;
            return this;
        }

        /**
         * 设置用户资料反垃圾检测
         * @param antispamConfig 用户资料反垃圾检测
         * @return {@link V2NIMChatroomEnterParamsBuilder}
         */
        public V2NIMChatroomEnterParamsBuilder withAntispamConfig(V2NIMAntispamConfig antispamConfig) {
            this.antispamConfig = antispamConfig;
            return this;
        }

        /**
         * 构建{@link V2NIMChatroomEnterParams}
         * @return {@link V2NIMChatroomEnterParams}
         */
        public V2NIMChatroomEnterParams build() {
            return new V2NIMChatroomEnterParams(anonymousMode, enableLbs, accountId, token, roomNick, roomAvatar, timeout, loginOption, linkProvider, serverExtension, notificationExtension, tagConfig, locationConfig, antispamConfig);
        }
    }
}