App.EmailPasswordClient を構造化
EmailPasswordプロバイダーにログインするユーザーの機能をカプセル化するクラス。 スコープは常に特定のアプリに限定され、 EmailPasswordAuth経由でのみアクセスできます。
継承されたノード
名前空間: Realm 。同期
組み立て: Realm.dll
構文
public readonly struct App.EmailPasswordClientメソッド
| このページを編集 ソースを表示CallResetPasswordFunctionAsync(string, string, param object?[])
サーバー上で設定されたリセット パスワード機能を呼び出します。
宣言
public Task CallResetPasswordFunctionAsync(string email, string password, params object?[] functionArgs)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | メールアドレス | ユーザーのメール。 |
| string | パスワード | ユーザーの新しいパスワード。 |
| オブジェクト[] | functionArgs | リセット関数に提供される追加の引数。 すべての引数は JSON 互換値にシリアル化できる必要があります。 |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | パスワード リセット関数を呼び出すための非同期リクエストを表す 待機可能なタスク。 正常に完了した場合は、ユーザーのパスワードが変更されたことを示し、新しいパスワードを使用してEmailPassword(string, string)認証情報を作成し、 LogInAsync(Credentials)を呼び出してログインできるようになります。 |
ConfirmUserAsync(string, string)
指定されたトークンとトークン ID を持つユーザーを確認します。 これらは通常、登録後にユーザーが受け取ったメールに含まれます。
宣言
public Task ConfirmUserAsync(string token, string tokenId)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | token | 確認トークン。 |
| string | tokenId | 確認トークンの ID。 |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | 非同期 ConfirmUser 操作を表す待機可能なタスク。 正常に完了した場合は、サーバー上でユーザーが確認されたことを示します。 |
コメント
確認は通常ウェブ アプリで行われますが、ディープ リンクが有効になっているモバイル アプリケーションは URL をインターセプし、アプリ自体でユーザー確認フローを完了できます。
RegisterUserAsync(string, string)
指定されたメールとパスワードで新しいユーザーを登録します。
宣言
public Task RegisterUserAsync(string email, string password)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | メールアドレス | 登録するメール。 これはユーザーのユーザー名になり、ユーザー確認が有効になっている場合は確認メールのアドレスになります。 |
| string | パスワード | メールに関連付けるパスワード。 パスワードの長さは 6 文字から 128 文字の間で、 |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | 非同期 RegisterUser 操作を表す 待機可能なタスク。 正常に完了した場合は、ユーザーがサーバー上に作成され、 EmailPassword(string, string) とともに LogInAsync (Credentials) を呼び出してログインできることを示します。 |
ResendConfirmationEmailAsync(string)
ユーザーの確認メールを指定されたメールに再送信します。
宣言
public Task ResendConfirmationEmailAsync(string email)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | メールアドレス | ユーザーのメール。 |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | 確認メールが送信されるサーバーへの非同期リクエストを表す待機可能なタスク。 正常に完了した場合は、サーバーがリクエストを受け入れたことを示し、そのメールを持つユーザーが存在する場合は、指定されたアドレスに確認メールが送信されます。 |
ResetPasswordAsync(string, string, string)
必要な新しいパスワードを提供して、パスワードのリセット フローを完了します。
宣言
public Task ResetPasswordAsync(string password, string token, string tokenId)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | パスワード | ユーザーの新しいパスワード。 |
| string | token | ユーザーのメールアドレスに送信されたパスワードリセットトークン。 |
| string | tokenId | ユーザーのメールアドレスに |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | ユーザーのパスワードがリセットされるという非同期リクエストを表す待機可能なTask 。 正常に完了した場合は、ユーザーのパスワードがリセットされ、新しいパスワードを使用してEmailPassword(string, string)認証情報を作成し、 LogInAsync(Credentials)を呼び出してログインできるようになりました。 |
コメント
パスワードのリセット フローは通常ウェブ アプリで完了しますが、ディープ リンクが有効になっているモバイル アプリケーションは URL をインターセプし、アプリ自体でパスワード リセットのフローを完了できます。
RetryCustomConfirmationAsync(string)
指定されたメールのカスタム確認機能を再実行します。
宣言
public Task RetryCustomConfirmationAsync(string email)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | メールアドレス | ユーザーのメール。 |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | カスタム確認関数が再度実行されるというサーバーへの非同期リクエストを表す待機可能なTask 。 正常に完了した場合は、サーバー上でユーザーが確認されたことを示します。 |
送信ResetPasswordEmailAsync(string)
指定されたアドレスにパスワード リセット メールを送信します。
宣言
public Task SendResetPasswordEmailAsync(string email)パラメーター
| タイプ | 名前 | 説明 |
|---|---|---|
| string | メールアドレス | ユーザーのメールアドレス。 |
戻り値
| タイプ | 説明 |
|---|---|
| タスク | パスワード リセット メールが送信されるというサーバーへの非同期リクエストを表す待機可能なタスク。 正常に完了した場合は、サーバーがリクエストを受け入れたことを示し、そのメールを持つユーザーが存在する場合は、指定されたアドレスにパスワード リセットのメールが送信されます。 |