Struct App.EmailPasswordClient

一个类，封装使用EmailPassword提供商登录的用户的功能。它的作用域始终限于特定应用，并且只能通过EmailPasswordAuth访问。

继承成员

ValueType.ToString()

命名空间： Realm 。 Sync

程序集：Realm.dll

语法

public readonly struct App.EmailPasswordClient

方法

CallResetPasswordFunctionAsync(string, string, params 对象?[])

调用服务器上配置的重置密码函数。

声明

public Task CallResetPasswordFunctionAsync(string email, string password, params object?[] functionArgs)

参数

类型	名称	说明
字符串	电子邮件	用户的电子邮件。
字符串	密码	用户的新密码。
对象 []	functionArgs	提供给重置函数的任何其他参数。 所有参数都必须可序列化为 JSON 兼容值。

返回：

类型	说明
任务	一个可等待任务，表示调用密码重置函数的异步请求。 成功完成表示用户的密码已更改，他们现在可以使用新密码创建EmailPassword(string, string)档案并调用LogInAsync(Credentials)进行登录。

ConfirmUserAsync(string, string)

使用给定的令牌和令牌 ID 确认用户。 这些通常包含在用户注册后收到的电子邮件中。

声明

public Task ConfirmUserAsync(string token, string tokenId)

参数

类型	名称	说明
字符串	token	确认令牌。
字符串	tokenId	确认令牌的 ID。

返回：

类型	说明
任务	表示异步 ConfirmUser 操作的可等待任务。 成功完成表示用户已在服务器上得到确认。

备注

虽然确认通常发生在网络应用程序中，但启用了深度链接的移动应用程序可以拦截 URL 并在应用程序本身中完成用户确认流程。

RegisterUserAsync(string, string)

使用给定的电子邮件和密码注册新用户。

声明

public Task RegisterUserAsync(string email, string password)

参数

类型	名称	说明
字符串	电子邮件	要注册的电子邮件。 这将是用户的用户名，如果启用了用户确认，这将是确认电子邮件的地址。
字符串	密码	与电子邮件关联的密码。 密码长度必须介于 6 到 128 个字符之间。

返回：

类型	说明
任务	表示异步 RegisterUser 操作的可等待任务。 成功完成表示已在服务器上创建用户，现在可以调用LogInAsync(Credentials)和EmailPassword(string, string)进行登录。

ResendConfirmationEmailAsync(string)

将用户的确认电子邮件重新发送到给定电子邮件。

声明

public Task ResendConfirmationEmailAsync(string email)

参数

类型	名称	说明
字符串	电子邮件	用户的电子邮件。

返回：

类型	说明
任务	一个可等待任务，表示向服务器发送确认电子邮件的异步请求。 成功完成表示服务器已接受请求，并且如果存在具有该电子邮件的用户，则会向指定地址发送一封确认电子邮件。

ResetPasswordAsync(string, string, string)

提供所需的新密码，完成重置密码流程。

声明

public Task ResetPasswordAsync(string password, string token, string tokenId)

参数

类型	名称	说明
字符串	密码	用户的新密码。
字符串	token	发送到用户电子邮件地址的密码重置令牌。
字符串	tokenId	与token一起发送到用户电子邮件地址的密码重置令牌 ID。

返回：

类型	说明
任务	一个可等待任务，表示重置用户密码的异步请求。 成功完成表示用户的密码已重置，他们现在可以使用新密码创建EmailPassword(string, string)档案并调用LogInAsync(Credentials)进行登录。

备注

虽然重置密码流程通常在 Web 应用程序中完成，但启用深度链接的移动应用程序可以拦截 URL 并在应用程序本身中完成密码重置流程。

RetryCustomConfirmationAsync(string)

为给定邮件重新运行自定义确认功能。

声明

public Task RetryCustomConfirmationAsync(string email)

参数

类型	名称	说明
字符串	电子邮件	用户的电子邮件。

返回：

类型	说明
任务	一个可等待任务，表示向服务器发出的异步请求，要求再次运行自定义确认函数。 成功完成表示用户已在服务器上得到确认。

SendResetPasswordEmailAsync(string)

向指定地址发送密码重置电子邮件。

声明

public Task SendResetPasswordEmailAsync(string email)

参数

类型	名称	说明
字符串	电子邮件	用户的电子邮件。

返回：

类型	说明
任务	一个可等待任务，表示向服务器发送重置密码电子邮件的异步请求。 成功完成表示服务器已接受请求，并且如果存在使用该电子邮件的用户，则会向指定地址发送密码重置电子邮件。