currentUser

开发者可以调用 BaaS.auth.getCurrentUser() 获取 currentUser 对象,通过该对象进而对当前用户进行管理。同时登录注册等接口也会返回 currentUser 对象。

获取 currentUser 对象

BaaS.auth.getCurrentUser()

示例代码

  1. wx.BaaS.auth.getCurrentUser().then(user => {
  2. // user 为 currentUser 对象
  3. }).catch(err => {
  4. // HError
  5. if( err.code === 604 ){
  6. console.log('用户未登录')
  7. }
  8. })
  1. qq.BaaS.auth.getCurrentUser().then(user => {
  2. // user 为 currentUser 对象
  3. }).catch(err => {
  4. // HError
  5. if( err.code === 604 ){
  6. console.log('用户未登录')
  7. }
  8. })
  1. BaaS.auth.getCurrentUser().then(user => {
  2. // user 为 currentUser 对象
  3. }).catch(err => {
  4. // HError
  5. if( err.code === 604 ){
  6. console.log('用户未登录')
  7. }
  8. })
  1. my.BaaS.auth.getCurrentUser().then(user => {
  2. // user 为 currentUser 对象
  3. }).catch(err => {
  4. // HError
  5. if( err.code === 604 ){
  6. console.log('用户未登录')
  7. }
  8. })
  1. swan.BaaS.auth.getCurrentUser().then(user => {
  2. // user 为 currentUser 对象
  3. }).catch(err => {
  4. // HError
  5. if( err.code === 604 ){
  6. console.log('用户未登录')
  7. }
  8. })

若当前为未登录状态,则会抛出错误。

currentUser 对象说明

currentUser 代表了当前登录的用户,开发者可以通过浏览 currentUser 上的字段来获取当前用户的信息,通过调用 currentUser 上的方法来更新用户信息。该对象关联 userprofile 表中 id 为当前用户 ID 的数据行。currentUser 字段包含了 _userprofile表的所有的内置字段_,自定义字段可以通过 currentUser.get(key) 来获取。

  1. // currentUser 数据结构
  2. {
  3. avatar: "...",
  4. city: "...",
  5. country: "...",
  6. created_at: 1557474865,
  7. created_by: 45768973992321,
  8. gender: 1,
  9. get: function (key) {}
  10. id: 45768973992321,
  11. is_authorized: true,
  12. language: "...",
  13. nickname: "...",
  14. openid: "...", // 微信小程序用户的唯一标识,非微信用户将返回空值。同时,微信小程序 openid 也会和其他平台一样,在 _provider 里存储一份。
  15. province: "...",
  16. session_expires_at": 1561283491,
  17. toJSON: function () {},
  18. unionid: "...", // 微信开发平台用户的唯一标识,非微信用户将返回空值
  19. updated_at: 1558691521,
  20. user_id: 45768973992321,
  21. _anonymous: false,
  22. _email_verified : false,
  23. _provider: {
  24. alipay: {
  25. avatar: "...",
  26. province: "...",
  27. city: "...",
  28. nick_name: "...",
  29. is_student: true,
  30. user_type: "...",
  31. user_status: "...",
  32. verified: true,
  33. gender: "..."
  34. },
  35. wechat: {
  36. avatar: "...",
  37. city: "...",
  38. country: "...",
  39. gender: 1,
  40. language: "...",
  41. nickname: "...",
  42. openid: "...",
  43. province: "...",
  44. unionid: "...",
  45. }
  46. }
  47. }

获取用户自定义字段

开发者可能会在 _userprofile 表中定义一些自定义字段,要拿到这些自定义字段信息,可以通过如下两个 API 来获取:

  • currentUser.get(key)
  • currentUser.toJSON()

currentUser.get(key)

通过 currentUser.get(key) 可以获取用户的单个字段(包括内置字段和自定义字段)。

示例代码

假设开发者在 _userprofile 表中定义了 custom_name 列,并设置当前用户的 custom_nameifanrx。则在 SDK 中查询当前用户自定义字段代码如下:

  1. wx.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.get('custom_name')) // ifanrx
  3. })
  1. qq.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.get('custom_name')) // ifanrx
  3. })
  1. BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.get('custom_name')) // ifanrx
  3. })
  1. my.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.get('custom_name')) // ifanrx
  3. })
  1. swan.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.get('custom_name')) // ifanrx
  3. })

currentUser.toJSON()

可以通过 currentUser.toJSON() API,来获得一次性获取完整的用户信息。

示例代码假设开发者在 _userprofile 表中定义了 custom_name 列,并设置当前用户的 custom_nameifanrx。则在 SDK 中查询当前用户自定义字段代码如下:

  1. wx.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.toJSON())
  3. })
  1. qq.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.toJSON())
  3. })
  1. BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.toJSON())
  3. })
  1. my.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.toJSON())
  3. })
  1. swan.BaaS.auth.getCurrentUser().then(user => {
  2. console.log(user.toJSON())
  3. })

返回示例

  1. {
  2. "id": 5123461461,
  3. "avatar": "http://cdn.ifanr.cn/ifanr/default_avatar.png",
  4. "nickname": "riDGldYXLHouWIYx",
  5. "_anonymous": false,
  6. "_username": "myusername",
  7. "_email": "myemail@somemail.com",
  8. "_email_verified": false,
  9. "_provider": {
  10. "alipay": {
  11. "avatar": "http://tfsimg.alipay.com/images/partner/T1uIxXXbpXXXXXXXX",
  12. "province": "安徽省",
  13. "city": "安庆",
  14. "nick_name": "支付宝小二",
  15. "is_student": true,
  16. "user_type": "company_account",
  17. "user_status": "authenticated",
  18. "verified": true,
  19. "gender": "F"
  20. }
  21. }
  22. }

字段说明请参考 获取用户信息小节

判断用户是否是匿名用户

  1. wx.BaaS.auth.getCurrentUser().then(user => {
  2. if (user._anonymous) {
  3. // 匿名用户
  4. } else {
  5. // 非匿名用户
  6. }
  7. })
  1. qq.BaaS.auth.getCurrentUser().then(user => {
  2. if (user._anonymous) {
  3. // 匿名用户
  4. } else {
  5. // 非匿名用户
  6. }
  7. })
  1. BaaS.auth.getCurrentUser().then(user => {
  2. if (user._anonymous) {
  3. // 匿名用户
  4. } else {
  5. // 非匿名用户
  6. }
  7. })
  1. my.BaaS.auth.getCurrentUser().then(user => {
  2. if (user._anonymous) {
  3. // 匿名用户
  4. } else {
  5. // 非匿名用户
  6. }
  7. })
  1. swan.BaaS.auth.getCurrentUser().then(user => {
  2. if (user._anonymous) {
  3. // 匿名用户
  4. } else {
  5. // 非匿名用户
  6. }
  7. })

设置用户信息

currentUser 对象提供了一些方法,用于修改当前用户信息。

常见使用场景:

  • 用户的用户名/邮箱设置有误,需要修改为新的用户名/邮箱。
  • 用户使用小程序授权登录后,通过设置用户名或邮箱,以便下次通过用户名或邮箱登录。

除更新自定义字段外,其他方法匿名用户无法调用

初始化账号信息

匿名用户无法调用

currentUser.setAccount({username, email, password})

用户通过微信、支付宝授权登录后,可以设置用户名、邮箱、密码,以便下次通过用户名或邮箱登录。

参数说明

名称类型必填说明
usernameStringN用户名
emailStringN邮箱
passwordStringY初始密码

示例代码

  1. // ...
  2. wx.BaaS.auth.getCurrentUser()
  3. .then(user => {
  4. return user.setAccount({username: 'hello', email: 'hello@ifanr.com', password: '111111'})
  5. }).then(user => {
  6. console.log(user)
  7. }).catch(err => {
  8. // HError
  9. })
  1. // ...
  2. qq.BaaS.auth.getCurrentUser()
  3. .then(user => {
  4. return user.setAccount({username: 'hello', email: 'hello@ifanr.com', password: '111111'})
  5. }).then(user => {
  6. console.log(user)
  7. }).catch(err => {
  8. // HError
  9. })
  1. // ...
  2. BaaS.auth.getCurrentUser()
  3. .then(user => {
  4. return user.setAccount({username: 'hello', email: 'hello@ifanr.com', password: '111111'})
  5. }).then(user => {
  6. console.log(user)
  7. }).catch(err => {
  8. // HError
  9. })
  1. // ...
  2. my.BaaS.auth.getCurrentUser()
  3. .then(user => {
  4. return user.setAccount({username: 'hello', email: 'hello@ifanr.com', password: '111111'})
  5. }).then(user => {
  6. console.log(user)
  7. }).catch(err => {
  8. // HError
  9. })
  1. // ...
  2. swan.BaaS.auth.getCurrentUser()
  3. .then(user => {
  4. return user.setAccount({username: 'hello', email: 'hello@ifanr.com', password: '111111'})
  5. }).then(user => {
  6. console.log(user)
  7. }).catch(err => {
  8. // HError
  9. })

设置用户名

匿名用户无法调用

用户名不区分大小写。当用户设置了 username 为 ifanrx 的账号后,其他人不能再注册诸如 Ifanrx、IfAnrx、IFANRX 等账号了

currentUser.setUsername(username)

参数说明

名称类型说明
usernameString新用户名

示例代码

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setUsername('ifanrx_new')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setUsername('ifanrx_new')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setUsername('ifanrx_new')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setUsername('ifanrx_new')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setUsername('ifanrx_new')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })

返回结果说明

user 为 currentUser 对象,该对象的说明见上文

err 对象结构请参考错误码和 HError 对象

设置邮箱

匿名用户无法调用

邮箱中的英文字母会被强制转换为小写。例如 iFanrX@Hello.com 会被转换成 ifanrx@hello.com

currentUser.setEmail(email, {sendVerificationEmail})

参数说明

名称类型必填说明
emailStringY新邮箱
sendVerificationEmailBooleanN是否发送验证邮件,默认为 false

示例代码

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setEmail('ifanrx_new@ifanr.com', {sendVerificationEmail: true})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setEmail('ifanrx_new@ifanr.com', {sendVerificationEmail: true})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setEmail('ifanrx_new@ifanr.com', {sendVerificationEmail: true})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setEmail('ifanrx_new@ifanr.com', {sendVerificationEmail: true})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setEmail('ifanrx_new@ifanr.com', {sendVerificationEmail: true})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })

返回结果说明

user 为 currentUser 对象,该对象的说明见上文

err 对象结构请参考错误码和 HError 对象

设置手机号

匿名用户无法调用

重新设置手机号后,需要重新验证手机号。

currentUser.setMobilePhone(mobilePhone)

参数说明

名称类型必填说明
mobilePhoneStringY新手机号

示例代码

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setMobilePhone('15000000000')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setMobilePhone('15000000000')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setMobilePhone('15000000000')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setMobilePhone('15000000000')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.setMobilePhone('15000000000')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })

返回结果说明

user 为 currentUser 对象,该对象的说明见上文

err 对象结构请参考错误码和 HError 对象

验证手机号

匿名用户无法调用

短信验证码 smsCode 通过接口 BaaS.sendSmsCode() 获取,请查看文档

currentUser.verifyMobilePhone(smsCode)

参数说明

名称类型必填说明
smsCodeStringY短信验证码

示例代码

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.verifyMobilePhone('123456')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.verifyMobilePhone('123456')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.verifyMobilePhone('123456')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.verifyMobilePhone('123456')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.verifyMobilePhone('123456')
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })

返回结果说明

user 为 currentUser 对象,该对象的说明见上文

err 对象结构请参考错误码和 HError 对象

更新密码

匿名用户无法调用

currentUser.updatePassword({password, newPassword})

参数说明:

名称类型说明
passwordString用户密码 (若用户当前密码为空则为
newPasswordString新用户密码 (若用户当前密码为空则为必填

示例代码

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.updatePassword({password: '111111', newPassword: '222222'})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.updatePassword({password: '111111', newPassword: '222222'})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.updatePassword({password: '111111', newPassword: '222222'})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.updatePassword({password: '111111', newPassword: '222222'})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.updatePassword({password: '111111', newPassword: '222222'})
  4. }).then(user => {
  5. console.log(user)
  6. }).catch(err => {
  7. // HError
  8. })

返回结果说明

user 为 currentUser 对象,该对象的说明见上文err 对象结构请参考错误码和 HError 对象

更新用户自定义字段

更新用户信息与数据表更新数据项方法基本一致。这里只允许更新 _userprofile 表中自定义的字段。

请求示例

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. // age 为自定义字段
  4. return user.set('age', 30).update()
  5. }).then(user => {
  6. // success
  7. }).catch(err => {
  8. // err 为 HError 对象
  9. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. // age 为自定义字段
  4. return user.set('age', 30).update()
  5. }).then(user => {
  6. // success
  7. }).catch(err => {
  8. // err 为 HError 对象
  9. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. // age 为自定义字段
  4. return user.set('age', 30).update()
  5. }).then(user => {
  6. // success
  7. }).catch(err => {
  8. // err 为 HError 对象
  9. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. // age 为自定义字段
  4. return user.set('age', 30).update()
  5. }).then(user => {
  6. // success
  7. }).catch(err => {
  8. // err 为 HError 对象
  9. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. // age 为自定义字段
  4. return user.set('age', 30).update()
  5. }).then(user => {
  6. // success
  7. }).catch(err => {
  8. // err 为 HError 对象
  9. })

邮箱验证

匿名用户无法调用

currentUser.requestEmailVerification()

当用户通过邮箱注册后或者修改了邮箱后,开发者可能希望对用户填写的邮箱真实性进行校验,调用该 API 后,知晓云会向当前用户发送一封验证邮件,用户可以打开邮件并进行验证操作。

示例代码

  1. wx.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.requestEmailVerification()
  4. }).then(res => {
  5. console.log(res)
  6. }).catch(err => {
  7. // HError
  8. })
  1. qq.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.requestEmailVerification()
  4. }).then(res => {
  5. console.log(res)
  6. }).catch(err => {
  7. // HError
  8. })
  1. BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.requestEmailVerification()
  4. }).then(res => {
  5. console.log(res)
  6. }).catch(err => {
  7. // HError
  8. })
  1. my.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.requestEmailVerification()
  4. }).then(res => {
  5. console.log(res)
  6. }).catch(err => {
  7. // HError
  8. })
  1. swan.BaaS.auth.getCurrentUser()
  2. .then(user => {
  3. return user.requestEmailVerification()
  4. }).then(res => {
  5. console.log(res)
  6. }).catch(err => {
  7. // HError
  8. })

返回结果

成功时 res 结构如下

  1. {
  2. "statusCode": 201,
  3. "data": { "status": "ok" }
  4. }

err 对象结构请参考错误码和 HError 对象

同步第一层级用户信息

2.x 支持多平台登录,第三方登录(微信小程序中使用微信登录与支付宝小程序中使用支付宝登录,都属于第三方登录)后获取到的用户信息保存在 userpofile 记录的 _provider 字段(参照上文 currentUser 中的 _provider 字段)中,而 1.x 的用户数据保存在与 _provider 同一层级(即第一层级)的字段中,为了使相关代码能平滑升级到 2.x,第一层级的用户信息字段被保留了下来,并提供了接口让开发者决定是否在用户授权的时候,同步第一层级的用户信息。

支持的接口:

  • 微信登录
    • wx.BaaS.loginWithWechat(data, {syncUserProfile})
    • UserRecord.linkWechat(data, {syncUserProfile})
  • 支付宝登录

    • my.BaaS.loginWithAlipay({forceLogin, syncUserProfile})
    • UserRecord.linkAlipay({forceLogin, syncUserProfile})支持同步的字段:
  • nickname: 昵称

  • avatar: 头像
  • gender: 性别(仅微信)
  • language: 语言
  • city: 城市
  • province: 省份
  • country: 国家