Struct app.EmailPasswordClient

Uma classe, encapsulando funcionalidade para usuários, conectados com o provedor EmailPassword . Ele sempre tem o escopo de um aplicativo específico e só pode ser acessado via EmailPasswordAuth.

Membros herdados

ValueType.ToString()

namespace: Realms.sincronizar

Conjunto: Realm.exe

Sintaxe

public readonly struct App.EmailPasswordClient

Métodos

CallResetPasswordFunctionAsync(string, string, params objeto?[])

Chama a função de redefinição de senha, configurada no servidor.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	Email	O e-mail do usuário.
string	Senha	A nova senha do usuário.
objeto[]	functionArgs	Quaisquer argumentos adicionais fornecidos para a função de redefinição. Todos os argumentos devem ser serializáveis para valores compatíveis com JSON.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável que representa a solicitação assíncrona para chamar uma função de redefinição de senha. A conclusão bem-sucedida indica que a senha do usuário foi alterada e agora ele pode usar a nova senha para criar credenciais EmailPassword(string, string) e chamar LogInAsync(Credentials) para fazer login.

ConfirmUserAsync(string, string)

Confirma um usuário com o token e ID de token fornecidos. Eles normalmente são incluídos no e-mail que o usuário recebe após o registro.

Declaração

public Task ConfirmUserAsync(string token, string tokenId)

Parâmetros

Tipo	Nome	Descrição
string	token	O token de confirmação.
string	tokenId	A ID do token de confirmação.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável que representa a operação assíncrona ConfirmUser. A conclusão bem-sucedida indica que o usuário foi confirmado no servidor.

Observações

Embora a confirmação normalmente aconteça em um aplicativo da web, os aplicativos móveis que têm o link detalhado habilitado podem interceptar a URL e concluir o fluxo de confirmação do usuário no próprio aplicativo.

RegistreUserAsync(string, string)

Registra um novo usuário com o e-mail e a senha fornecidos.

Declaração

public Task RegisterUserAsync(string email, string password)

Parâmetros

Tipo	Nome	Descrição
string	Email	O e-mail com o qual se registrar. Este será o nome de usuário do usuário e, se a confirmação do usuário estiver habilitada, este será o endereço para o e-mail de confirmação.
string	Senha	A senha para associar ao e-mail. A senha deve ter entre 6 e 128 caracteres.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável representando a operação assíncrona RegistrarUser. A conclusão bem-sucedida indica que o usuário foi criado no servidor e agora pode ser conectado chamando LogInAsync(Credentials) com EmailPassword(string, string).

ReendConfirmationEmailAsync(string)

Reenvia o e-mail de confirmação de um usuário para o e-mail fornecido.

Declaração

public Task ResendConfirmationEmailAsync(string email)

Parâmetros

Tipo	Nome	Descrição
string	Email	O e-mail do usuário.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável que representa a solicitação assíncrona ao servidor de que um e-mail de confirmação é enviado. A conclusão bem-sucedida indica que o servidor aceitou a solicitação e enviará um e-mail de confirmação para o endereço especificado se existir um usuário com esse e-mail.

ResetPasswordAsync(string, string, string)

Conclui o fluxo de redefinição de senha fornecendo a nova senha desejada.

Declaração

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

Parâmetros

Tipo	Nome	Descrição
string	Senha	A nova senha do usuário.
string	token	O token de redefinição de senha que foi enviado para o endereço de e-mail do usuário.
string	tokenId	O ID do token de redefinição de senha que foi enviado junto com o token para o endereço de e-mail do usuário.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável que representa a solicitação assíncrona de que a senha de um usuário é redefinida. A conclusão bem-sucedida indica que a senha do usuário foi redefinida e agora ele pode usar a nova senha para criar credenciais EmailPassword(string, string) e chamar LogInAsync(Credentials) para fazer login.

Observações

Embora o fluxo de redefinição de senha normalmente seja concluído no aplicativo web, os aplicativos móveis que têm o link detalhado ativado podem interceptar a URL e concluir o fluxo de redefinição de senha no próprio aplicativo.

RetryCustomConfirmationAsync(string)

Execute novamente a função de confirmação personalizada para o e-mail fornecido.

Declaração

public Task RetryCustomConfirmationAsync(string email)

Parâmetros

Tipo	Nome	Descrição
string	Email	O e-mail do usuário.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável que representa a solicitação assíncrona ao servidor de que a função de confirmação personalizada é executada novamente. A conclusão bem-sucedida indica que o usuário foi confirmado no servidor.

SendResetPasswordEmailAsync(string)

Envia um e-mail de redefinição de senha para o endereço especificado.

Declaração

public Task SendResetPasswordEmailAsync(string email)

Parâmetros

Tipo	Nome	Descrição
string	Email	o e-mail do usuário.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável que representa a solicitação assíncrona ao servidor de que um e-mail de redefinição de senha é enviado. A conclusão bem-sucedida indica que o servidor aceitou a solicitação e enviará um e-mail de redefinição de senha para o endereço especificado se existir um usuário com esse e-mail.