Usuário da classe

Esta classe representa um usuário em um aplicativo Atlas App Services. As credenciais são fornecidas por vários provedores terceirizados (Facebook, Google, etc.). Um usuário pode fazer login no servidor e, se o acesso for concedido, é possível sincronizar o Realm local e o remoto. Além disso, a sincronização é interrompida quando o usuário é desconectado. É possível persistir um usuário. Ao recuperar um usuário, não há necessidade de fazer login no provedor terceirizado novamente. Ao persistir um usuário entre as sessões, as credenciais do usuário são armazenadas localmente no dispositivo e devem ser tratadas como dados confidenciais.

Herança

objeto

Usuário

Implementos

IEquatable<Usuário>

namespace: Realms.sincronizar

Conjunto: Realm.exe

Sintaxe

public class User : IEquatable<User>

Propriedades

AccessToken

Obtém o token de acesso desse usuário. Esta é a credencial do usuário para acessar dados do MongoDB Atlas e deve ser tratada como informação confidencial.

Declaração

public string AccessToken { get; }

Valor da propriedade

Tipo	Descrição
string	Uma string única que pode ser usada para representar este usuário antes do servidor.

Chaves de API

Obtém uma instância User.ApiKeyClient que expõe a funcionalidade para gerenciar chaves de API do usuário.

Declaração

public User.ApiKeyClient ApiKeys { get; }

Valor da propriedade

Tipo	Descrição
Usuário.ClienteApiKeyClient	Uma instância User.ApiKeyClient com escopo para este User.

Veja também

Documentos de autenticação de chaves de API

Aplicação

Obtém o aplicativo ao qual este usuário está associado.

Declaração

public App App { get; }

Valor da propriedade

Tipo	Descrição
Aplicação	Uma instância de aplicativo que possui esse usuário.

DeviceId

Obtém um identificador exclusivo para o dispositivo em que o usuário se conectou.

Declaração

public string DeviceId { get; }

Valor da propriedade

Tipo	Descrição
string	Uma string exclusiva que identifica o dispositivo atual.

Funções

Obtém uma instância User.FunctionsClient que expõe a funcionalidade para chamar Função de Realm remotas.

Declaração

public User.FunctionsClient Functions { get; }

Valor da propriedade

Tipo	Descrição
Usuário.FunctionsClient	Uma instância User.FunctionsClient com escopo para este User.

Veja também

Documentos de funções

id

Obtém o ID deste usuário no Atlas App Services.

Declaração

public string Id { get; }

Valor da propriedade

Tipo	Descrição
string	Uma string que identifica exclusivamente esse usuário.

Identidades

Obtém uma collection de todas as identidades associadas a este usuário.

Declaração

public UserIdentity[] Identities { get; }

Valor da propriedade

Tipo	Descrição
UserIdentity[]	As identidades do usuário em diferentes Credentials.AuthProviders.

perfil

Obtém as informações de perfil desse usuário.

Declaração

public UserProfile Profile { get; }

Valor da propriedade

Tipo	Descrição
Perfil do usuário	Um objeto UserProfile , contendo informações sobre o nome do usuário, e-mail e assim por diante.

Fornecedor

Obtém um valor indicando com qual Credentials.AuthProvider esse usuário se conectou.

Declaração

[Obsolete("User.Provider wasn't working consistently and will be removed in a future version. You can get the provider of the user identity instead.")]
public Credentials.AuthProvider Provider { get; }

Valor da propriedade

Tipo	Descrição
Credenciais.AuthProvider	O Credentials.AuthProvider usado para fazer login do usuário.

AtualizarToken

Obtém o token de atualização desse usuário. Esta é a credencial do usuário para acessar dados do MongoDB Atlas e deve ser tratada como informação confidencial.

Declaração

public string RefreshToken { get; }

Valor da propriedade

Tipo	Descrição
string	Uma string exclusiva que pode ser usada para atualizar as credenciais do usuário.

Estado

Obtém o estado atual do usuário.

Declaração

public UserState State { get; }

Valor da propriedade

Tipo	Descrição
Estado do usuário	Um valor que indica se o usuário está ativo, desconectado ou ocorreu um erro.

Métodos

Iguais(Usuário?)

Determina se esta instância e outra instância de Usuário são iguais comparando suas identidades.

Declaração

public bool Equals(User? other)

Parâmetros

Tipo	Nome	Descrição
Usuário	Outro	A instância do usuário com a qual comparar.

Devoluções

Tipo	Descrição
bool	true se as duas instâncias forem iguais; false caso contrário.

GetCustomData()

Obtém os dados de usuário personalizados associados a esse usuário no aplicativo Realm.

Declaração

public BsonDocument? GetCustomData()

Devoluções

Tipo	Descrição
Documento BSON	Um documento contendo os dados do usuário.

Observações

Os dados só são atualizados quando o token de acesso do usuário é atualizado ou ao chamar explicitamente RefreshCustomDataAsync().

Veja também

Documentos de dados de usuário personalizados

GetCustomData<T>()

Obtém os dados personalizados do usuário associados a esse usuário no aplicativo Realm e os analisa para o tipo especificado.

Declaração

public T? GetCustomData<T>() where T : class

Devoluções

Tipo	Descrição
t	Um documento contendo os dados do usuário.

Parâmetros de tipo

Nome	Descrição
t	O tipo managed que corresponde à forma do documento de dados personalizados.

Observações

Os dados só são atualizados quando o token de acesso do usuário é atualizado ou ao chamar explicitamente RefreshCustomDataAsync().

Veja também

Documentos de dados de usuário personalizados

GetMongoClient(string)

Obtém uma instância MongoClient para acessar documento em um MongoDB database.

Declaração

public MongoClient GetMongoClient(string serviceName)

Parâmetros

Tipo	Nome	Descrição
string	serviceName	O nome do serviço conforme configurado no servidor.

Devoluções

Tipo	Descrição
Cliente Mongo	Uma instância do MongoClient que pode interagir com o reconhecimento de data center expostos no serviço remoto.

LinkCredentialsAsync(Credentials)

Vincula o usuário atual a uma nova identidade de usuário representada pelas credenciais fornecidas.

Declaração

public Task<User> LinkCredentialsAsync(Credentials credentials)

Parâmetros

Tipo	Nome	Descrição
Credenciais	credenciais	As credenciais para vincular ao usuário atual.

Devoluções

Tipo	Descrição
Tarefa<Usuário>	Um awaitable Task<TResult> representando a operação de credenciais de link remoto. Após a conclusão bem-sucedida, o resultado da tarefa conterá o usuário ao qual as credenciais foram vinculadas.

Observações

Ao vincular um usuário com mais credenciais, o usuário pode fazer login em qualquer uma dessas credenciais. Também torna possível "atualizar" um usuário anônimo, vinculando-o, por exemplo, Credenciais de e-mail/senha.
Observação: Não é possível vincular dois usuários existentes do Atlas App Services. As credenciais fornecidas não devem ter sido usadas por outro usuário.
Observação para autenticação de e-mail/senha: para vincular um usuário com um novo conjunto de credenciais EmailPassword(string, string) , você precisará primeiro registrar essas credenciais chamando RegistreUserAsync(string, string).

Exemplos

O trecho a seguir mostra como associar um e-mail e uma senha a um usuário anônimo, permitindo que ele faça login em um dispositivo diferente.

var app = App.Create("app-id")
var user = await app.LogInAsync(Credentials.Anonymous());

// This step is only needed for email password auth - a password record must exist
// before you can link a user to it.
await app.EmailPasswordAuth.RegisterUserAsync("email", "password");
await user.LinkCredentialsAsync(Credentials.EmailPassword("email", "password"));

LogOutAsync()

Remove as credenciais locais do usuário e tenta invalidar seu token de atualização do servidor.

Declaração

public Task LogOutAsync()

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardada que representa a operação de logout remoto.

RefreshCustomDataAsync()

Buscar novamente os dados personalizados do usuário no servidor.

Declaração

public Task<BsonDocument?> RefreshCustomDataAsync()

Devoluções

Tipo	Descrição
Tarefa<BSONDocument>	Um Task<TResult> aguardável que representa a operação de atualização remota. O resultado é um MongoDB.Bson.BsonDocument contendo os dados de usuário personalizados atualizados. O valor retornado por GetCustomData() também será atualizado com as novas informações.

RefreshCustomDataAsync<T>()

Buscar novamente os dados personalizados do usuário no servidor.

Declaração

public Task<T?> RefreshCustomDataAsync<T>() where T : class

Devoluções

Tipo	Descrição
Tarefa<T>	Um Task<TResult> aguardável que representa a operação de atualização remota. O resultado é um objeto contendo os dados de usuário personalizados atualizados. O valor retornado por GetCustomData<T>() também será atualizado com as novas informações.

Parâmetros de tipo

Nome	Descrição
t	O tipo managed que corresponde à forma do documento de dados personalizados.

ToString()

Retorna uma string que representa o objeto atual.

Declaração

public override string ToString()

Devoluções

Tipo	Descrição
string	Uma string que representa o objeto atual.

Substitui

object.ToString()

Eventos

Alterado

Ocorre quando o valor de uma propriedade muda.

Declaração

public event EventHandler? Changed

eventType

Tipo	Descrição
EventHandler

Operadores

operador ==(Usuário?, Usuário?)

Determina se duas instâncias de usuário são iguais.

Declaração

public static bool operator ==(User? user1, User? user2)

Parâmetros

Tipo	Nome	Descrição
Usuário	user1	O primeiro usuário a comparar.
Usuário	user2	O segundo usuário a comparar.

Devoluções

Tipo	Descrição
bool	true se as duas instâncias forem iguais; false caso contrário.

operador !=(Usuário?, Usuário?)

Determina se duas instâncias de usuário são diferentes.

Declaração

public static bool operator !=(User? user1, User? user2)

Parâmetros

Tipo	Nome	Descrição
Usuário	user1	O primeiro usuário a comparar.
Usuário	user2	O segundo usuário a comparar.

Devoluções

Tipo	Descrição
bool	true se as duas instâncias forem diferentes; false caso contrário.

Implementos

IEquatable<T>