SDK 1.x 版本升级至 2.x 版本
@cloudbase/js-sdk@2.x 相比 1.x,做了登录模块的重新设计,而其他资源模块(函数,数据库,存储)的使用方式不变。
迁移指南
新旧版本登录模块对比(接口&属性)
LoginType 相关
SDK 2.x 登录模块移除了 loginType 概念,不再对外暴露 ANONYMOUS, WECHAT, CUSTOM, EMAIL, PHONE 等类型。
提示
解释
LoginState 相关
| 废弃 API(属性) | 说明 |
|---|---|
| Auth.onLoginStateExpired | SDK 登录完成后, 内部维护登录态,无需开发者关心是否过期 |
| LoginState.loginType | 废弃 loginType |
| LoginState.isAnonymousAuth | 废弃 loginType |
| LoginState.isCustomAuth | 废弃 loginType |
| LoginState.isWeixinAuth | 废弃 loginType |
| LoginState.isUsernameAuth | 废弃 loginType |
AuthProvider 相关
| 废弃 API(属性) | 说明 |
|---|---|
| Auth.weixinAuthProvider | 改为统一的第三方授权登录接口,参考接口 |
| Auth.customAuthProvider | 废弃 customAuthProvider,改为 Auth.signInWithCustomTicket |
| Auth.anonymousAuthProvider | 废弃 anonymousAuthProvider,改为 Auth.signInAnonymously |
User 相关
废弃属性
| API(属性) | 说明 |
|---|---|
| User.loginType | 废弃 loginType |
| User.openid | 废弃 User.openid, 使用参考新增属性 User.providers |
| User.wxOpenId | 废弃 User.wxOpenId,使用参考新增属性 User.providers |
| User.wxPublicId | 废弃 User.wxPublicId,使用参考新增属性 User.providers |
| User.qqMiniOpenId | 废弃 User.qqMiniOpenId,使用参考新增属性 User.providers |
| User.customUserId | 废弃 User.customUserId,用户唯一标识使用 User.uid |
| User.nickName | 废弃 User.nickName,昵称使用新增属性 User.name |
| User.avatarUrl | 废弃 User.avatarUrl,头像使用新增属性 User.picture |
| User.hasPassword | 废弃 User.hasPassword |
| User.location | 废弃 User.location |
| User.linkWithTicket | 已废弃,目前自定义登录 userId 与云开发 uid 一致,无需关联操作 |
| User.linkWithRedirect | 废弃 User.linkWithRedirect,使用新接口 Auth.bindWithProvider |
| User.linkWithPhoneNumber | 废弃 User.linkWithPhoneNumber,使用新接口 Auth.bindPhoneNumber |
| User.updateEmail | 废弃 User.updateEmail,使用新接口 Auth.bindEmail |
| User.updatePhoneNumber | 废弃 User.updatePhoneNumber Auth.bindPhoneNumber |
新增属性
| API(属性) | 说明 |
|---|---|
| User.name | 用户昵称(区分与 登录用户名 User.username) |
| User.picture | 用户上传头像 |
| User.phone_number | 用户绑定手机号 |
| User.email_verified | 用户是否经过邮箱验证 |
| User.birthdate | 用户生日 |
| User.locale | 用户设置语言 |
| User.zoneinfo | 时区 |
| User.providers | 参考UserProfileProvider |
UserProfileProvider
| 字段 | 说明 |
|---|---|
| id | 默认内置的三方 providerid,wx_open, wx_mp |
| provider_user_id | 第三方 provider 用户 id (如 wxopenid) |
| name | 名称 |
Auth API 相关
新增 API
| API | 说明 |
|---|---|
| Auth.signIn | 登录接口(除匿名登录,第三方登录) |
| Auth.signUp | 注册接口 |
| Auth.getVerification | 统一获取验证码接口(手机号,邮箱) |
| Auth.bindPhoneNumber | 绑定/更新手机号(原更新用户信息方式不再支持) |
| Auth.bindEmail | 绑定/更新邮箱 (原更新用户信息方式不再支持) |
| Auth.bindWithProvider | 绑定第三方平台(如微信开放/公众平台) |
| Auth.unbindProvider | 解绑第三方平台 |
| Auth.setPassword | 设置密码 |
| Auth.queryUser | 条件查询用户信息 |
| Auth.signInWithProvider | 第三方平台登录 |