Extends
Methods
(async) authLogin(loginOptions, configOptions, beforeResopt, authData) → {BaseAuth~LoginRes}
- Source:
- Overrides:
授权登录
需要用户配合点击授权按钮/输入表单等才能完成的登录过程
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:
- Overrides:
进行授权登录之前的准备工作
时序:beforeAuthLogin -> 用户交互,同意授权 -> authLogin
Parameters:
Name | Type | Description |
---|---|---|
loginOptions |
Object | 登录函数调用参数,参见BaseLogin#login |
configOptions |
Object | 登录模块配置参数,参见BaseLogin#config |
Returns:
需要传递给authLogin的数据
- Type
- *
(async) loginByWxAuth(wxLoginRes, authData, loginOptions, configOptions) → {BaseAuth~LoginRes}
- Source:
微信授权登录
根据用户同意授权后从微信处拿到的信息,完成登录过程
Parameters:
Name | Type | Description |
---|---|---|
wxLoginRes |
WechatAuth~WxLoginRes | wx.login执行结果 |
authData |
Object | 登录界面交互结果,格式同wx.getUserInfo返回结果 |
loginOptions |
登录函数调用参数,参见BaseLogin#login |
|
configOptions |
登录模块配置参数,参见BaseLogin#config |
Returns:
- Type
- BaseAuth~LoginRes
(async) loginByWxSilent(wxLoginRes, loginOptions, configOptions) → {BaseAuth~LoginRes}
- Source:
微信静默登录
根据wxLoginRes.code调后端接口解密获得用户openid,根据openid查询用户表
若为老用户,则能成功从数据库中找到匹配项,从而悄悄完成登录过程
若为新用户,则静默登录失败
Parameters:
Name | Type | Description |
---|---|---|
wxLoginRes |
WechatAuth~WxLoginRes | wx.login执行结果 |
loginOptions |
登录函数调用参数,参见BaseLogin#login |
|
configOptions |
登录模块配置参数,参见BaseLogin#config |
Returns:
- Type
- BaseAuth~LoginRes
(async) silentLogin(loginOptions, configOptions) → {BaseAuth~LoginRes}
- Source:
- Overrides:
静默登录
可以在用户无感知的情况下后台悄悄完成的登录过程
Parameters:
Name | Type | Description |
---|---|---|
loginOptions |
Object | 登录函数调用参数,参见BaseLogin#login |
configOptions |
Object | 登录模块配置参数,参见BaseLogin#config |
Returns:
- Type
- BaseAuth~LoginRes
(async) wxLogin() → {WechatAuth~WxLoginRes}
- Source:
微信登录:调用微信相关API,获取微信登录态
Returns:
wx.login执行结果
Type Definitions
WxLoginRes
- Source:
Properties:
Name | Type | Description |
---|---|---|
succeeded |
boolean | 是否成功 |
code |
string | wx.login接口返回的code |
wx.login执行结果
Type:
- Object