title: WDGUser

title: WDGUser

Wilddog Auth 的用户对象。

属性

anonymous

定义

@property(nonatomic, readonly, getter=isAnonymous) BOOL anonymous

说明

如果为 YES 则表明为匿名用户。

emailVerified

定义

@property(nonatomic, readonly, getter=isEmailVerified) BOOL emailVerified

说明

如果为 YES 则表示和这个帐号关联的邮箱已经验证过。

phoneVerified

定义

@property(nonatomic, readonly, getter=isPhoneVerified) BOOL phoneVerified

说明

如果为 YES 则表示和这个帐号关联的手机号已经验证过。

providerData

定义

@property(nonatomic, readonly, nonnull) NSArray<id<WDGUserInfo>> *providerData

说明

所有登录方式的用户信息。

参考 不同登录方式之间可以相互绑定，绑定之后可以以任意一种登录方式登录主帐号。

方法

- init

定义

- (nullable instancetype)init NS_UNAVAILABLE;

说明

不要初始化这个对象。

参考 使用 WDGAuth.currentUser 来获取用户对象。

- updateEmail:completion:

定义

- (void)updateEmail:(NSString *)email completion:(nullable WDGUserProfileChangeCallback)completion

说明

更新帐号邮箱。如果更新成功，本地缓存也会刷新。

参数

参考

如果这个邮箱已经创建过用户，则会更新失败。 可能发生的错误：

• WDGAuthErrorCodeEmailAlreadyInUse 邮箱地址已经被其他账户使用。
• WDGAuthErrorCodeInvalidEmail 该邮箱地址无效。
• WDGAuthErrorCodeCredentialTooOldLoginAgain 发生这个错误表明用户在短期内没有登录过，而修改邮箱为敏感操作，必须重新登录才能继续操作。可以调用 WDGUser.reauthenticateWithCredential:completion: 方法。

• 参见 WDGAuthErrors API 调用可能发生的所有错误。

  
  

- updatePassword:completion:

定义

- (void)updatePassword:(NSString *)password
            completion:(nullable WDGUserProfileChangeCallback)completion

说明

修改用户密码。如果成功，本地缓存也会被刷新。

参数

参考

可能发生的错误：

• WDGAuthErrorCodeAuthenticationDisabled 未开启身份认证功能，请在控制台开启后重试。
• WDGAuthErrorCodeCredentialTooOldLoginAgain 发生这个错误表明用户在短期内没有登录过，而修改密码为敏感操作，必须重新登录才能继续操作。可以调用 WDGUser.reauthenticateWithCredential:completion: 方法。
• WDGAuthErrorCodePasswordLengthError 密码的长度必须在 6 到 32 位。
• 参见 WDGAuthErrors API 调用可能发生的所有错误。

- updatePhone:completion:

定义

- (void)updatePhone:(NSString *)phone completion:(nullable WDGUserProfileChangeCallback)completion

说明

更换用户手机号。如果成功，本地缓存也会被刷新。

参数

参考

可能发生的错误：

• 参见 WDGAuthErrors API 调用可能发生的所有错误。

- profileChangeRequest

定义

- (WDGUserProfileChangeRequest *)profileChangeRequest

说明

创建一个可以改变用户信息的对象。

返回值

返回一个可以用来原子性的修改用户信息的对象。也就是说不会单独某个属性修改成功，而其它的修改失败。

参考

修改完这个返回对象的属性，然后调用 WDGUserProfileChangeRequest.commitChangesWithCallback: 来完成用户信息的修改。

- reloadWithCompletion:

定义

- (void)reloadWithCompletion:(nullable WDGUserProfileChangeCallback)completion

说明

从服务器上获取最新的用户信息。

参数

参考

可能返回 WDGAuthErrorCodeInvalidCredential 错误。这种情况下，需要调用 WDGUser.reauthenticateWithCredential:completion: 重新登录。

可能发生的错误：

• 参见 WDGAuthErrors API 调用可能发生的所有错误。
  

- reauthenticateWithCredential:completion:

定义

- (void)reauthenticateWithCredential:(WDGAuthCredential *)credential
                          completion:(nullable WDGUserProfileChangeCallback)completion

说明

重新登录，刷新本地 idToken。

参数

参考

如果用户提供的凭证和之前的不一样或者提供的凭证是错误的。则返回错误信息。当前用户继续保持登录状态。

可能发生的错误：

• WDGAuthErrorCodeInvalidCredentials 该身份认证凭证无效。
• WDGAuthErrorCodeAuthenticationDisabled 这种登录方式被禁止，可以在野狗应用控制面板打开这个选项。
• WDGAuthErrorCodeEmailAlreadyInUse 邮箱地址已经被其他账户使用。
• WDGAuthErrorCodeInvalidUser 该用户不存在。
• WDGAuthErrorCodeInvalidPassword 该密码不正确。
• 参见更多错误请参考 WDGAuthErrors。

- getTokenWithCompletion:

定义

- (void)getTokenWithCompletion:(nullable WDGAuthTokenCallback)completion

说明

获取用户 token。

参数

参考

可能发生的错误：

• 参见 WDGAuthErrors API 调用可能发生的所有错误。

- linkWithCredential:completion:

定义

- (void)linkWithCredential:(WDGAuthCredential *)credential
                completion:(nullable WDGAuthResultCallback)completion

说明

将第三方帐号绑定到当前用户上。以实现通过不同的登录方式登录。

参数

参考

可能发生的错误：

• WDGAuthErrorCodeProviderAlreadyLinked 每个用户只能绑定一次野狗登录方式。
• WDGAuthErrorCodeAuthenticationDisabled 未开启身份认证功能，请在控制台开启后重试。
• 这个方法也有可能返回 updateEmail:completion: 和 updatePassword:completion: 的错误。
• 参见更多错误请参考 WDGAuthErrors。

- unlinkFromProvider:completion:

定义

- (void)unlinkFromProvider:(NSString *)provider
                completion:(nullable WDGAuthResultCallback)completion

说明

解绑第三方帐号。

参数

参考

可能发生的错误：

• WDGAuthErrorCodeCredentialTooOldLoginAgain 该用户尝试安全敏感操作，但登录时间过长，需重新登录。
• 参见更多错误请参考 WDGAuthErrors。

- sendEmailVerificationWithCompletion:

定义

- (void)sendEmailVerificationWithCompletion:(nullable WDGSendEmailVerificationCallback)completion

说明

发送邮箱验证。

参数

参考

可能发生的错误：

• WDGAuthErrorCodeUserNotFound 没有对应用户记录，该用户可能已经被删除。
• 参见更多错误请参考 WDGAuthErrors。
  

- sendPhoneVerificationWithCompletion:

定义

- (void)sendPhoneVerificationWithCompletion:(nullable WDGSendPhoneVerificationCallback)completion

说明

发送验证手机的验证码。

参数

参考

可能发生的错误：

• WDGAuthErrorCodeUserNotFound 没有对应用户记录，该用户可能已经被删除。
• 参见更多错误请参考 WDGAuthErrors。
  

- verifyPhoneWithSmsCode:completion:

定义

- (void)verifyPhoneWithSmsCode:(NSString *)code completion:(nullable WDGVerifyPhoneCallback)completion

说明

用 sendEmailVerificationWithCompletion 方法发送验证码后，收到的验证码需要用此方法验证。

参数

参考

可能发生的错误：

• 参见更多错误请参考 WDGAuthErrors。
  

- deleteWithCompletion:

定义

- (void)deleteWithCompletion:(nullable WDGUserProfileChangeCallback)completion

说明

删除这个帐号（如果是当前用户，则退出登录）。

参数

参考

可能发生的错误：

• WDGAuthErrorCodeCredentialTooOldLoginAgain 敏感操作，需要重新登录来确保安全性。可以调用 WDGUser.reauthenticateWithCredential:completion:
• 参见更多错误请参考 WDGAuthErrors。