BaseAuth

BaseAuth

鉴权模块基类
负责根据用户提供的信息,完成校验过程,并返回对应的登录数据

Constructor

new BaseAuth()

Source:

Methods

(async) authLogin(loginOptions, configOptions, beforeResopt, authData) → {BaseAuth~LoginRes}

Source:

授权登录
需要用户配合点击授权按钮/输入表单等才能完成的登录过程

Parameters:
Name Type Attributes Description
loginOptions Object

登录函数调用参数,参见BaseLogin#login

configOptions Object

登录模块配置参数,参见BaseLogin#config

beforeRes * <optional>

beforeAuthLogin钩子执行结果

authData Object

登录界面交互结果

Returns:
Type
BaseAuth~LoginRes

(async) beforeAuthLogin(loginOptions, configOptions) → {*}

Source:

进行授权登录之前的准备工作
时序:beforeAuthLogin -> 用户交互,同意授权 -> authLogin

Parameters:
Name Type Description
loginOptions Object

登录函数调用参数,参见BaseLogin#login

configOptions Object

登录模块配置参数,参见BaseLogin#config

Returns:

需要传递给authLogin的数据

Type
*

(async) silentLogin(loginOptions, configOptions) → {BaseAuth~LoginRes}

Source:

静默登录
可以在用户无感知的情况下后台悄悄完成的登录过程

Parameters:
Name Type Description
loginOptions Object

登录函数调用参数,参见BaseLogin#login

configOptions Object

登录模块配置参数,参见BaseLogin#config

Returns:
Type
BaseAuth~LoginRes

Type Definitions

LoginRes

Source:
Properties:
Name Type Attributes Description
succeeded boolean

是否成功

errMsg string

详细错误信息,调试用

toastMsg string <optional>

错误信息话术,向用户提示用

userInfo Object

(成功时)用户信息

expireTime number

(成功时)过期时间,绝对毫秒数,-1表示长期有效

anonymousInfo Object <optional>

(不管成功失败)匿名信息,登录成功前使用的临时标识,成功后继续关联

鉴权模块登录结果

Type:
  • Object