Classe Usuário.ApiKeyClient

Uma classe que expõe a funcionalidade para os usuários managed as chaves de API do cliente. Ele sempre tem o escopo de um usuário específico e só pode ser acessado por meio de ApiKeys.

Herança

objeto

User.ApiKeyClient

namespace: Realms.sincronizar

Conjunto: Realm.exe

Sintaxe

public class User.ApiKeyClient

Métodos

CreateAsync(string)

Cria uma chave de API que pode ser usada para autenticar como usuário.

Declaração

public Task<ApiKey> CreateAsync(string name)

Parâmetros

Tipo	Nome	Descrição
string	name	O nome amigável da chave.

Devoluções

Tipo	Descrição
Tarefa<ApiKey>	Um Task<TResult> esperável representando a operação assíncrona. A conclusão bem-sucedida indica que a ApiKey foi criada no servidor e seu Value pode ser usado para criar ApiKey(string).

Observações

O valor da chave de API retornada deve ser mantido neste momento, pois essa é a única vez em que ela estará visível. A chave é habilitada quando criada. Ele pode ser desabilitado chamando DisableAsync(ObjectId).

DeleteAsync(ObjectId)

Exclui uma chave de API por ID.

Declaração

public Task DeleteAsync(ObjectId id)

Parâmetros

Tipo	Nome	Descrição
ObjectId	id	A ID da chave a ser excluída.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável representando a operação de exclusão assíncrona.

DisableAsync(ObjectId)

Desabilita uma chave de API por ID.

Declaração

public Task DisableAsync(ObjectId id)

Parâmetros

Tipo	Nome	Descrição
ObjectId	id	A ID da chave a ser desabilitada.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável representando a operação assíncrona de desativação.

Veja também

EnableAsync(ObjectId)

EnableAsync(ObjectId)

Habilita uma chave de API por id.

Declaração

public Task EnableAsync(ObjectId id)

Parâmetros

Tipo	Nome	Descrição
ObjectId	id	A ID da chave a ser habilitada.

Devoluções

Tipo	Descrição
Tarefa	Uma tarefa aguardável representando a operação de habilitação assíncrona.

Veja também

DisableAsync(ObjectId)

FetchAllAsync()

Busca todas as chaves API associadas ao usuário.

Declaração

public Task<IEnumerable<ApiKey>> FetchAllAsync()

Devoluções

Tipo	Descrição
Tarefa<IEnumerable<ApiKey>	Uma tarefa aguardável representando a operação de pesquisa assíncrona. Ao completar, o resultado contém uma collection de todas as chaves de API para esse usuário.

FetchAsync(ObjectId)

Busca uma chave de API de usuário específica por ID.

Declaração

public Task<ApiKey?> FetchAsync(ObjectId id)

Parâmetros

Tipo	Nome	Descrição
ObjectId	id	A ID da chave a ser buscada.

Devoluções

Tipo	Descrição
Tarefa<ApiKey>	Um Task<TResult> aguardável representando a operação de pesquisa assíncrona.