用户管理 | 开发文档

本篇文档介绍如何使用 Wilddog Auth 管理用户。它包括：创建用户、获取用户信息、获取用户属性、更新用户信息、删除用户等。

创建用户

创建用户包含以下四种方法：

通过手机登录创建
通过邮箱密码创建
通过第三方身份认证提供商授权创建
在控制面板—身份认证—用户中手动创建

获取用户信息

用户信息包含用户属性及用户的登录信息。

获取当前登录用户

获取当前登录用户是管理用户的基础。

获取当前登录用户包含以下两种方法：

在 Auth 实例上设置监听器
使用 currentUser 方法

使用监听器：

Objective-C
Swift

[[WDGAuth auth] addAuthStateDidChangeListener:^(WDGAuth *_Nonnull auth,
                                                WDGUser *_Nullable user) {
  if (user != nil) {
    // 用户已登录
  } else {
    // 没有用户登录
  }
}];

WDGAuth.auth()?.addStateDidChangeListener{ auth, user in
    if let user = user {
        // 用户已登录
    } else {
        // 没有用户登录
    }
}

使用 currentUser 方法：

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;

if (user != nil) {
  // 用户已登录
} else {
  // 没有用户登录
}

if let user = WDGAuth.auth()?.currentUser {
    // 用户已登录
} else {
    // 没有用户登录
}

注意：

推荐使用监听器，这样可以保证在你获取当前用户时 Auth 实例不会处于中间状态，如用户正在登录时。

获取用户属性

WDGUser 实例可以用于获取用户属性。

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;

if (user != nil) {
  NSString *name = user.displayName;
  NSString *phone = user.phone;
  NSString *email = user.email;
  NSURL *photoUrl = user.photoURL;
  NSString *uid = user.uid;       
} else {
  // 没有用户登录
}

if let user = WDGAuth.auth()?.currentUser {
    let name = user.displayName
    let phone = user.phone
    let email = user.email
    let photoUrl = user.photoURL
    let uid = user.uid;  
} else {
    // 没有用户登录
}

获取 Provider 的用户属性

providerData 用于获取所有 Provider 的用户属性。

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;

if (user != nil) {
  for (WDGUserInfo *profile in user.providerData) {
    NSString *providerID = profile.providerID;
    NSString *uid = profile.uid;  // Provider-specific UID
    NSString *name = profile.displayName;
    NSString *phone = profile.phone;
    NSString *email = profile.email;
    NSURL *photoURL = profile.photoURL;
  }
} else {
  // 没有用户登录
}

if let user = WDGAuth.auth()?.currentUser {
    for profile in user.providerData {
        let providerID = profile.providerID
        let uid = profile.uid;  // Provider-specific UID
        let name = profile.displayName
        let phone = user.phone
        let email = profile.email
        let photoURL = profile.photoURL
    }
} else {
    // 没有用户登录
}

更新用户信息

User 实例用于更新用户属性及用户的登录信息。

更新用户属性

WDGUserProfileChangeRequest 类用于更新用户属性。

例如，更新用户的displayName 和 photoURL 属性：

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;
WDGUserProfileChangeRequest *changeRequest = [user profileChangeRequest];

changeRequest.displayName = @"JianDong. User";
changeRequest.photoURL =
    [NSURL URLWithString:@"https://example.com/jane-q-user/profile.jpg"];
[changeRequest commitChangesWithCompletion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 更新成功
  }
}];

let user = WDGAuth.auth()?.currentUser
if let user = user {
    let changeRequest = user.profileChangeRequest()
    
    changeRequest.displayName = "Jane Q. User"
    changeRequest.photoURL =
        NSURL(string: "https://example.com/jane-q-user/profile.jpg") as URL?
    changeRequest.commitChanges { error in
        if let error = error {
            // 发生错误
        } else {
            // 更新成功
        }
    }
}

注意：

使用 customToken 登录时，若该登录用户为 admin 用户，则不能更新用户属性。

更新用户手机号

updatePhone:completion: 方法用于更新用户手机号。

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;

[user updatePhone:@"13888888888" completion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 更新成功
  }
}];

let user = WDGAuth.auth()?.currentUser

user?.updatePhone("13888888888") { error in
    if let error = error {
        // 发生错误
    } else {
        // 更新成功
    }
}

重置手机号认证密码

1.发送重置密码的手机验证码：

Objective-C
Swift

[[WDGAuth auth] sendPasswordResetSmsWithPhone:@"18888888888"
                                   completion:^(NSError * _Nullable error) {
                                       // ...
                                   }];

WDGAuth.auth()?.sendPasswordResetSms(withPhone: "18888888888") { (error) in
  // ...
}

2.确认重置密码的手机验证码：

Objective-C
Swift

[[WDGAuth auth] confirmPasswordResetSmsWithPhone:@"18888888888"
                                         smsCode:realSms
                                     newPassword:@"newpassword123"
                                      completion:^(NSError * _Nullable error) {
                                         // ...
                                      }];

WDGAuth.auth()?.confirmPasswordResetSms(withPhone: "18888888888", smsCode: realSms, newPassword: "newpassword123") { (error) in
  // ...
}

更新邮箱地址

updateEmail:completion: 方法用于更新用户邮箱地址。

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;

[user updateEmail:@"user@example.com" completion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 更新成功
  }
}];

let user = WDGAuth.auth()?.currentUser

user?.updateEmail("user@example.com") { error in
    if let error = error {
        // 发生错误
    } else {
        // 更新成功
    }
}

注意：

要更新用户的邮箱地址，该用户必须最近登录过。请参考重新进行身份认证。

使用 customToken 登录时，若该登录用户为 admin 用户，则不能更新邮箱地址。

更新用户邮箱或手机号认证密码

updatePassword:completion: 方法用于更新用户邮箱或手机号认证密码。

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;
NSString *newPassword = [yourApp getRandomSecurePassword];

[user updatePassword:newPassword completion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 更新成功
  }
}];

let user = WDGAuth.auth()?.currentUser
let newPassword = getRandomSecurePassword()

user?.updatePassword(newPassword) { error in
    if let error = error {
        // 发生错误
    } else {
        // 更新成功
    }
}

注意：

要更新密码，该用户必须最近登录过。请参考重新进行身份认证。

使用 customToken 登录时，若该登录用户为 admin 用户，则不能更新用户密码。

发送重置密码邮件

sendPasswordResetWithEmail:completion: 方法用于向用户发送重置密码邮件。

Objective-C
Swift

NSString *email = @"user@example.com";

[[WDGAuth auth] sendPasswordResetWithEmail:email
                                completion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 发送成功
  }
}];

let email = "user@example.com"

WDGAuth.auth()?.sendPasswordReset(withEmail: email) { error in
    if let error = error {
        // 发生错误
    } else {
        // 发送成功
    }
}

注意：

在控制面板身份认证—登录方式—邮箱登录中可以设置邮件自定义模板。

删除用户

删除用户的方式有以下两种：

通过 deleteWithCompletion: 方法删除
在控制面板身份认证—用户 中手动删除

使用 deleteWithCompletion: 方法：

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;

[user deleteWithCompletion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 删除成功
  }
}];

let user = WDGAuth.auth()?.currentUser

user?.delete { error in
    if let error = error {
        // 发生错误
    } else {
        // 删除成功
    }
}

使用控制面板：

注意：

要删除用户，该用户必须最近登录过。请参考重新进行身份认证。

使用 customToken 登录时，若该登录用户为 admin 用户，则不能更新用户密码。

重新进行身份认证

用户长时间未登录的情况下进行下列安全敏感操作会失败：

删除帐户
设置主邮箱地址
更改密码

此时需要重新对用户进行身份认证。

reauthenticateWithCredential: 方法用于对用户重新进行身份认证。

Objective-C
Swift

WDGUser *user = [WDGAuth auth].currentUser;
WDGAuthCredential *credential; // 需要初始化

// Prompt the user to re-provide their sign-in credentials

[user reauthenticateWithCredential:credential completion:^(NSError *_Nullable error) {
  if (error) {
    // 发生错误
  } else {
    // 重新认证成功
  }
}];

let user = WDGAuth.auth()?.currentUser
var credential: WDGAuthCredential // 需要初始化

// Prompt the user to re-provide their sign-in credentials

user?.reauthenticate(with: credential, completion:  { (error) in
    if let error = error {
        // 发生错误
    } else {
        // 重新认证成功
    }
})

上次更新：2018-06-21