V2NIMChatroomLoginOption.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.auth.config.V2NIMRouteConfig;
import com.netease.nimlib.sdk.v2.auth.enums.V2NIMLoginAuthType;
import com.netease.nimlib.sdk.v2.chatroom.provider.V2NIMChatroomLoginExtensionProvider;
import com.netease.nimlib.sdk.v2.chatroom.provider.V2NIMChatroomTokenProvider;

import java.io.Serializable;


/**
 * 聊天室登录相关配置参数
 */
public class V2NIMChatroomLoginOption implements Serializable {

    /**
     * 认证模式，具体解释参见{@link V2NIMLoginAuthType}定义
     */
    private final V2NIMLoginAuthType authType;

    /**
     * token提供回调
     * authtype==1，客户侧动态token签算提供类
     * authtype==0， 默认静态token
     */
    private final V2NIMChatroomTokenProvider tokenProvider;

    /**
     * 在部分场景下，客户可能需要传输一些业务相关数据，则可采用该回调传输业务相关数据
     */
    private final V2NIMChatroomLoginExtensionProvider loginExtensionProvider;

    /// 登录抄送相关配置
    private final V2NIMRouteConfig routeConfig;

    private V2NIMChatroomLoginOption() {
        this(LOGIN_AUTH_TYPE_DEFAULT, null, null, null);
    }

    /**
     *
     * @param authType 认证模式，具体解释参见{@link V2NIMLoginAuthType}定义
     * @param tokenProvider token提供回调
     * @param loginExtensionProvider 在部分场景下，客户可能需要传输一些业务相关数据，则可采用该回调传输业务相关数据
     */
    public V2NIMChatroomLoginOption(V2NIMLoginAuthType authType, V2NIMChatroomTokenProvider tokenProvider, V2NIMChatroomLoginExtensionProvider loginExtensionProvider, V2NIMRouteConfig routeConfig) {
        this.authType = authType;
        this.tokenProvider = tokenProvider;
        this.loginExtensionProvider = loginExtensionProvider;
        this.routeConfig = routeConfig;
    }

    /**
     * 获取认证模式
     * @return 认证模式
     */
    public V2NIMLoginAuthType getAuthType() {
        return authType;
    }

    /**
     * 获取token提供回调
     * @return token提供回调
     */
    public V2NIMChatroomTokenProvider getTokenProvider() {
        return tokenProvider;
    }

    /**
     * 获取登录扩展回调
     * @return 登录扩展回调
     */
    public V2NIMChatroomLoginExtensionProvider getLoginExtensionProvider() {
        return loginExtensionProvider;
    }

    public V2NIMRouteConfig getRouteConfig() {
        return routeConfig;
    }

    @Override
    public String toString() {
        return "V2NIMChatroomLoginOption{" +
                "authType=" + authType +
                ", tokenProvider=" + tokenProvider +
                ", loginExtensionProvider=" + loginExtensionProvider +
                ", routeConfig=" + routeConfig +
                '}';
    }

    private static final V2NIMLoginAuthType LOGIN_AUTH_TYPE_DEFAULT = V2NIMLoginAuthType.V2NIM_LOGIN_AUTH_TYPE_DEFAULT;

    /**
     * 聊天室登录相关配置参数构造器
     */
    public static final class V2NIMChatroomLoginOptionBuilder {

        /**
         * 认证模式，默认为{@link V2NIMLoginAuthType#V2NIM_LOGIN_AUTH_TYPE_DEFAULT}
         */
        private V2NIMLoginAuthType authType = LOGIN_AUTH_TYPE_DEFAULT;
        /**
         * token提供回调
         */
        private V2NIMChatroomTokenProvider tokenProvider;
        /**
         * 登录扩展回调
         */
        private V2NIMChatroomLoginExtensionProvider loginExtensionProvider;

        private V2NIMRouteConfig routeConfig;

        private V2NIMChatroomLoginOptionBuilder() {
        }

        /**
         * 构建聊天室登录相关配置参数构造器
         * @return
         */
        public static V2NIMChatroomLoginOptionBuilder builder() {
            return new V2NIMChatroomLoginOptionBuilder();
        }

        /**
         * 设置认证模式
         * @param authType 认证模式
         * @return {@link V2NIMChatroomLoginOptionBuilder}
         */
        public V2NIMChatroomLoginOptionBuilder withAuthType(V2NIMLoginAuthType authType) {
            this.authType = authType;
            return this;
        }
        /**
         * 设置token提供回调
         * @param tokenProvider token提供回调
         * @return {@link V2NIMChatroomLoginOptionBuilder}
         */
        public V2NIMChatroomLoginOptionBuilder withTokenProvider(V2NIMChatroomTokenProvider tokenProvider) {
            this.tokenProvider = tokenProvider;
            return this;
        }
        /**
         * 设置登录扩展回调
         * @param loginExtensionProvider 登录扩展回调
         * @return {@link V2NIMChatroomLoginOptionBuilder}
         */
        public V2NIMChatroomLoginOptionBuilder withLoginExtensionProvider(V2NIMChatroomLoginExtensionProvider loginExtensionProvider) {
            this.loginExtensionProvider = loginExtensionProvider;
            return this;
        }


        public V2NIMChatroomLoginOptionBuilder withRouteConfig(V2NIMRouteConfig routeConfig) {
            this.routeConfig = routeConfig;
            return this;
        }

        /**
         * 构建聊天室登录相关配置参数
         * @return {@link V2NIMChatroomLoginOption}
         */
        public V2NIMChatroomLoginOption build() {
            return new V2NIMChatroomLoginOption(authType, tokenProvider, loginExtensionProvider, routeConfig);
        }
    }
}