QChatLoginParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat.param;

import android.text.TextUtils;

import androidx.annotation.NonNull;

import com.netease.nimlib.SDKCache;
import com.netease.nimlib.sdk.qchat.enums.QChatAuthType;

import java.util.List;

/**
 * "圈组登录"接口入参
 */
public class QChatLoginParam {

    /**
     * 圈组登录独立模式回调
     */
    public interface QChatLoginCallback {

        /**
         * 获取link地址列表
         * @param account 账户名
         * @return
         */
        List<String> getQChatLinkAddresses(final String account);
    }

    /**
     * 独立模式获取link地址列表回调
     */
    private final QChatLoginCallback loginCallback;

    /**
     * 用户名
     */
    private final String account;

    /**
     * 登录token
     */
    private final String token;
    /**
     * appkey 目前只支持传和IM模块相同的AppKey
     */
    private String appKey;
    /**
     * 鉴权方式，0表示最初的loginToken的校验方式，1表示基于appSecret计算的token鉴权方式，默认0
     */
    private final QChatAuthType authType;
    /**
     * 登录自定义字段，用于提交给用户的第三方回调服务进行登录检测，不会同步给其他端
     */
    private String loginExt;
    /**
     * 自定义客户端类型
     */
    private Integer customClientType;
    /**
     * 自定义推送文案类型
     */
    private String customPushContentType;
    /**
     * 客户端自定义tag,登录时多端同步改字段
     */
    private String customTag;


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


    /**
     * 获取用户账号
     *
     * @return 账号
     */
    public String getAccount() {
        return account;
    }

    /**
     * 获取用户token
     *
     * @return 登录口令
     */
    public String getToken() {
        return token;
    }

    /**
     * 获取鉴权方式
     * @return
     */
    @NonNull
    public QChatAuthType getAuthType() {
        return authType;
    }

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

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

    /**
     * 获取自定义客户端类型
     * @return
     */
    public Integer getCustomClientType() {
        return customClientType;
    }

    /**
     * 设置自定义客户端类型
     * @param customClientType
     */
    public void setCustomClientType(int customClientType) {
        this.customClientType = customClientType;
    }

    /**
     * 获取自定义Tag
     * @return
     */
    public String getCustomTag() {
        return customTag;
    }

    /**
     * 设置自定义Tag
     * @param customTag
     */
    public void setCustomTag(String customTag) {
        this.customTag = customTag;
    }

    /**
     * 获取自定义推送文案类型
     * @return
     */
    public String getCustomPushContentType() {
        return customPushContentType;
    }

    /**
     * 设置自定义推送文案类型,离线推送不显示详情时，要显示的文案对应的类型名称
     * @param customPushContentType
     */
    public void setCustomPushContentType(String customPushContentType) {
        this.customPushContentType = customPushContentType;
    }

    /**
     * 获取圈组登录独立模式回调
     * @return
     */
    public QChatLoginCallback getLoginCallback() {
        return loginCallback;
    }

    /**
     * 非独立模式下，圈组登录参数的构造函数，
     * 不需要传入account、token、appKey、authType、loginCallback
     * account、token、appKey、authType从IM模块获取，loginCallback设置为空
     * 其他参数通过setter方法设置
     */
    public QChatLoginParam() {
        this.account = SDKCache.getAuthInfo() == null ? "" : SDKCache.getAuthInfo().getAccount();
        this.token = SDKCache.getAuthInfo() == null ? "" : SDKCache.getAuthInfo().getToken();
        this.appKey = SDKCache.getAppKey();

        int authType = SDKCache.getAuthInfo() == null ? QChatAuthType.DEFAULT.getValue() : SDKCache.getAuthInfo().getAuthType();
        if (authType > QChatAuthType.DYNAMIC.getValue()) {
            this.authType = QChatAuthType.DEFAULT;
        } else {
            this.authType = QChatAuthType.typeOfValue(authType);
        }

        this.loginCallback = null;
    }

    /**
     * 独立模式下，圈组登录参数的构造函数，
     * 需要传入account、token、appKey、authType、loginCallback
     *
     * @param account 账户名
     * @param token 登录token，@NonNull，authType为DYNAMIC时传入空字符串""
     * @param appKey appKey
     * @param authType 鉴权模式
     * @param callback 独立模式使用，外部设置link地址
     */
    private QChatLoginParam(@NonNull String account, @NonNull String token, @NonNull String appKey, QChatAuthType authType, QChatLoginCallback callback) {
        this.loginCallback = callback;
        this.account = account;
        this.token = token;
        this.appKey = appKey;
        this.authType = authType;
    }

    /**
     * 数据是否有效，有效时才会进行登录操作，否则返回RES_EPARAM
     * @return
     */
    public boolean isValid() {
        if (authType == QChatAuthType.DEFAULT) {
            return !TextUtils.isEmpty(account) && !TextUtils.isEmpty(token) && !TextUtils.isEmpty(appKey);
        }

        if (authType == QChatAuthType.DYNAMIC) {
            return !TextUtils.isEmpty(account) && !TextUtils.isEmpty(appKey);
        }

        return false;
    }
}