Classe APIKeyAuth

Os Atlas Device SDKs estão obsoletos. Consulte apágina de descontinuação do para detalhes.

io.realm.mongodb.auth

java.lang.Object

io.realm.mongodb.auth.ApiKeyAuth

Esta aula expõe a funcionalidade para um usuário managed API sob seu controle.

Resumo do método

Modificador e tipo	Método e descrição
protegida abstrata nula	call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )
chave de APIpública	create ( String name ) Cria uma chave de API do usuário que pode ser usada para autenticar como o usuário.
RealmAsyncTaskpúblico	createAsync ( String name, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Cria de forma assíncrona uma chave de API do usuário que pode ser usada para autenticar como o usuário.
public void	delete ( ObjectId id ) Exclui uma chave de API específica criada pelo usuário.
RealmAsyncTaskpúblico	deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Exclui uma chave de API específica criada pelo usuário.
public void	disable ( ObjectId id ) Desabilita uma chave de API específica criada pelo usuário.
RealmAsyncTaskpúblico	disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Desabilita uma chave de API específica criada pelo usuário.
public void	enable ( ObjectId id ) Habilita uma chave de API específica criada pelo usuário.
RealmAsyncTaskpúblico	enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Habilita uma chave de API específica criada pelo usuário.
booleanopúblico	equals ( Object o )
chave de APIpública	fetch ( ObjectId id ) Busca uma chave de API de usuário específica associada ao usuário.
RealmAsyncTaskpúblico	fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback ) Busca todas as chaves API associadas ao usuário.
lista pública	fetchAll () Busca todas as chaves API associadas ao usuário.
RealmAsyncTaskpúblico	fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Busca uma chave de API de usuário específica associada ao usuário.
aplicativopúblico	getApp () Retorna o aplicativo com o qual esta instância está associada.
usuáriopúblico	getUser () Retorna o usuário com o qual esta instância está associada.
public int	hashCode ()
string pública	toString ()

Métodos herdados

Métodos herdados da classe java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Detalhes do método

Chame

protected abstract void call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )

criar

public ApiKey create (

String name

)

Cria uma chave de API do usuário que pode ser usada para autenticar como usuário.O valor da chave deve ser mantido nesse momento, pois esse é o único momento em que ela fica visível.

A chave está habilitada quando criada. Ele pode ser desabilitado chamando disable(ObjectId) .

Parâmetros

name - o nome da chave

Devoluções

a nova chave de API para o usuário.

Lança

AppException - se o servidor falhar ao criar a chave de API.

createAsync

public RealmAsyncTask createAsync (

String name,

io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback

)

Cria de forma assíncrona uma chave de API do usuário que pode ser usada para autenticar como usuário.O valor da chave deve ser mantido nesse momento, pois esse é o único momento em que ela fica visível.

A chave está habilitada quando criada. Ele pode ser desabilitado chamando disable(ObjectId) .

Parâmetros

name - o nome da chave
callback - chamada de resposta quando a criação da chave for concluída ou falhar. A chamada de resposta sempre acontecerá no mesmo thread em que este método é chamado.

Lança

Exceção de estado ilegal - se chamado de um thread não looper.

excluir

public void delete ( ObjectId id )
Exclui uma chave de API específica criada pelo usuário. Parâmetros `id` - o ID da chave a ser excluída. Lança AppException - se o servidor não conseguir excluir a chave de API.

deleteAsync

public RealmAsyncTask deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Exclui uma chave de API específica criada pelo usuário. Parâmetros `id` - o ID da chave a ser excluída. `callback` - chamada de resposta usada quando o foi excluído ou a chamada falhou. A chamada de resposta sempre ocorrerá na mesma thread em que este método foi chamado. Lança Exceção de estado ilegal - se chamado de um thread não looper.

desabilitar

public void disable ( ObjectId id )
Desabilita uma chave de API específica criada pelo usuário. Parâmetros `id` - o ID da chave a ser desabilitada. Lança AppException - se o servidor não conseguir desativar a chave de API.

disableAsync

public RealmAsyncTask disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Desabilita uma chave de API específica criada pelo usuário. Parâmetros `id` - o ID da chave a ser desabilitada. `callback` - chamada de resposta usada quando a chave foi desabilitada ou a chamada falhou. A chamada de resposta sempre ocorrerá na mesma thread em que este método foi chamado. Lança Exceção de estado ilegal - se chamado de um thread não looper.

habilitar

public void enable ( ObjectId id )
Habilita uma chave de API específica criada pelo usuário. Parâmetros `id` - o ID da chave a ser habilitada. Lança AppException - se o servidor não tiver ativado a chave de API.

enableAsync

public RealmAsyncTask enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Habilita uma chave de API específica criada pelo usuário. Parâmetros `id` - o ID da chave a ser habilitada. `callback` - chamada de resposta usada quando a chave foi habilitada ou a chamada falhou. A chamada de resposta sempre ocorrerá na mesma thread em que este método foi chamado. Lança Exceção de estado ilegal - se chamado de um thread não looper.

é igual a

public boolean equals ( Object o )
Substitui `equals` no objeto de classe

buscar

public ApiKey fetch ( ObjectId id )
Busca uma chave de API de usuário específica associada ao usuário. Parâmetros `id` - o ID da chave a ser buscada. Lança AppException - se o servidor não conseguir buscar a chave de API.

fetchAll

public RealmAsyncTask fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback )
Busca todas as chaves API associadas ao usuário. Parâmetros `callback` - chamada de resposta usada quando as chaves foram buscadas ou a chamada falhou. A chamada de resposta sempre ocorrerá na mesma thread em que este método foi chamado. Lança Exceção de estado ilegal - se chamado de um thread não looper.

public List fetchAll ()
Busca todas as chaves API associadas ao usuário. Lança AppException - se o servidor não conseguir buscar as chaves de API.

fetchAsync

public RealmAsyncTask fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback )
Busca uma chave de API de usuário específica associada ao usuário. Parâmetros `id` - o ID da chave a ser buscada. `callback` - chamada de resposta usada quando a chave foi buscada ou a chamada falhou. A chamada de resposta sempre ocorrerá na mesma thread em que este método foi chamado. Lança Exceção de estado ilegal - se chamado de um thread não looper.

getApp

public App getApp ()
Retorna o aplicativo com o qual esta instância está associada. Devoluções O aplicativo com o qual esta instância está associada.

getUser

public User getUser ()
Retorna o usuário com o qual esta instância está associada. Devoluções O usuário com o qual esta instância está associada.

hashCode

public int hashCode ()
Substitui `hashCode` no objeto de classe

toString

public String toString ()
Substitui `toString` no objeto de classe

Voltar

Chave de API

EmailPasswordAuth