Skip to content

Latest commit

 

History

History
345 lines (243 loc) · 9.11 KB

account.md

File metadata and controls

345 lines (243 loc) · 9.11 KB

当前用户

CurrentUser 类

CurrentUser 继承于 User。currentUser 实例代表了当前登录的用户，开发者可以通过访问 currentUser 上的属性来获取当前用户的信息，通过调用 currentUser 上的方法来更新用户信息。

获取 currentUser 对象

通过当前用户对象进而对当前用户进行管理，为了保证本地当前用户信息与服务器的用户信息一致，开发者只能通过两种方式获取到当前用户对象：

  1. 通过注册、登录后将获取当前用户对象。
  2. 通过以下方法获取当前用户：

{% tabs swift0="Swift", oc0="Objective-C" %} {% content "swift0" %}

// 用户管理对象
Auth.getCurrentUser { (currentUser, error) in

}

{% content "oc0" %}

// 用户管理对象
[BaaSAuth getCurrentUser:^(BaaSCurrentUser * _Nullable currentUser, NSError * _Nullable error) {

}];

{% endtabs %}

设置用户信息

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

常见使用场景：

  • 用户的用户名/邮箱设置有误，需要修改为新的用户名/邮箱。

info 除更新自定义字段外，其他方法临时用户无法调用。

设置用户名

info 临时用户无法调用

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

示例代码

{% tabs swift1="Swift", oc1="Objective-C" %} {% content "swift1" %}

currentUser.updateUsername("test_new") { (result, error) in

}

{% content "oc1" %}

[currentUser updateUsername:@"testoc_new" completion:^(NSDictionary<NSString *,id> * _Nullable result, NSError * _Nullable error) {

}];

{% endtabs %}

参数说明

名称 类型 说明
username String 新的用户名

结果返回

名称 类型 说明
result Dictionary 被更新的信息
error NSError 错误信息，参考错误处理和错误码

设置邮箱

info 临时用户无法调用

邮箱中的英文字母会被强制转换为小写。例如 [email protected] 会被转换成 [email protected] 。

示例代码

{% tabs swift2="Swift", oc2="Objective-C" %} {% content "swift2" %}

currentUser.updateEmail("[email protected]") { (result, error) in

}

{% content "oc2" %}

[currentUser updateEmail:@"[email protected]" completion:^(NSDictionary<NSString *,id> * _Nullable result, NSError * _Nullable error) {

}];

{% endtabs %}

参数说明

名称 类型 说明
username String 新的邮箱地址

结果返回

名称 类型 说明
result Dictionary 被更新的信息
error NSError 错误信息，参考错误处理和错误码

设置密码

info 临时用户无法调用

示例代码 {% tabs swift3="Swift", oc3="Objective-C" %} {% content "swift3" %}

currentUser.updatePassword("111", newPassword: "1111") { (result, error) in

}

{% content "oc3" %}

[currentUser updatePassword:@"111" newPassword:@"123" completion:^(NSDictionary<NSString *,id> * _Nullable result, NSError * _Nullable error) {

}];

{% endtabs %}

参数说明

参数说明：

名称 类型 说明
password String 用户密码 （若用户当前密码为空则为空）
newPassword String 新用户密码 (若用户当前密码为空则为必填）

结果返回

名称 类型 说明
result Dictionary 被更新的信息
error NSError 错误信息，参考错误处理和错误码

设置手机号

示例代码 {% tabs swift3_1="Swift", oc3_1="Objective-C" %} {% content "swift3_1" %}

currentUser.updatePhone("150****7274", completion: { (result, error) in
                        
})

{% content "oc3_1" %}

[currentUser updatePhone:@"150****7274" completion:^(NSDictionary<NSString *,id> * _Nullable result, NSError * _Nullable error) {

}];

{% endtabs %}

参数说明

参数说明：

名称 类型 说明 必填
phone String 用户手机号 Y

结果返回

名称 类型 说明
result Dictionary 被更新的信息
error NSError 错误信息，参考错误处理和错误码

验证当前用户手机号

info 匿名用户无法调用

用户登录后，可以验证手机号。验证后用户表的 _phone_verified 会被置为 true。若用户更新了手机号，_phone_verified 会被重置为 false。

验证步骤

  1. 调用 BaaS.sendSmsCode 发送手机短信验证码。

  2. 在验证手机号之前，若未设置手机号，需要先调用 updatePhone 接口给用户设置手机号。

  3. 获取验证码，验证手机号

示例代码 {% tabs swift5_0="Swift", oc5_0="Objective-C" %} {% content "swift5_0" %}

// 1. 发送手机短信验证码
BaaS.sendSmsCode(phone: "150****7274") { (success, error) in

}

// 2. 若用户未设置手机号，需要先设置手机号
currentUser?.updatePhone("150****7274", completion: { (result, error) in
                        
})

// 3. 验证手机号
currentUser?.verifyPhone(code: "12345", completion: { (success, error) in

})

{% content "oc5_0" %}

// 1. 发送手机验证码
[BaaS sendSmsCodeWithPhone:@"150****7274" completion:^(BOOL success, NSError * _Nullable error) {

}];

// 2. 若用户未设置手机号，需要先设置手机号
[currentUser updatePhone:@"150****7274" completion:^(NSDictionary<NSString *,id> * _Nullable result, NSError * _Nullable error) {

}];

// 3. 验证手机号
[currentUser verifyPhoneWithCode:@"12345" completion:^(BOOL success, NSError * _Nullable error) {
                       
}];

{% endtabs %}

参数说明：

名称 类型 说明 必填
code String 手机短信验证码 Y

结果返回

名称 类型 说明
success Bool 是否验证成功
error NSError 错误信息，参考错误处理和错误码

更新用户自定义字段

示例代码

{% tabs swift4="Swift", oc4="Objective-C" %} {% content "swift4" %}

currentUser.updateUserInfo(["age": 18]) { (result, error) in

}

{% content "oc4" %}

[currentUser updateUserInfo:@{@"age": @18} completion:^(NSDictionary<NSString *,id> * _Nullable result, NSError * _Nullable error) {

}];

{% endtabs %}

参数说明

参数说明：

名称 类型 说明
userInfo Dictionary 用户自定义字段信息

结果返回

名称 类型 说明
result Dictionary 被更新的信息
error NSError 错误信息，参考错误处理和错误码

邮箱验证

info 临时用户无法调用

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

示例代码 {% tabs swift5="Swift", oc5="Objective-C" %} {% content "swift5" %}

currentUser.requestEmailVerification() { (success, error) in

}

{% content "oc5" %}

[currentUser requestEmailVerification:^(BOOL success, NSError * _Nullable error) {

}];

{% endtabs %}

结果返回

名称 类型 说明
success Bool 是否已发送邮件
error NSError 错误信息，参考错误处理和错误码

通过邮件重置密码

当用户忘记了登录密码，可以通过邮件重置密码。

info 只有通过验证的邮箱才能使用邮件重置密码功能

示例代码

{% tabs swift6="Swift", oc6="Objective-C" %} {% content "swift6" %}

currentUser.resetPassword(email: "[email protected]") { (success, error) in

}

{% content "oc6" %}

[currentUser resetPasswordWithEmail:@"[email protected]" completion:^(BOOL success, NSError * _Nullable error) {

}];

{% endtabs %}

结果返回

名称 类型 说明
success Bool 是否已发送邮件
error NSError 错误信息，参考错误处理和错误码