Pacote io.realm.mongodb.auth

Classe APIKeyAuth

java.lang.Object

io.realm.mongodb.auth.ApiKeyAuth

public abstract class ApiKeyAuth
extends Object

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

Resumo do método

Modificador e tipo	Método	Descrição
ApiKey	create(String name)	Cria uma chave de API do usuário que pode ser usada para autenticar como o usuário.
RealmAsyncTask	createAsync(String name, App.Callback<ApiKey> callback)	Cria de forma assíncrona uma chave de API do usuário que pode ser usada para autenticar como o usuário.
void	delete(ObjectId id)	Exclui uma chave de API específica criada pelo usuário.
RealmAsyncTask	deleteAsync(ObjectId id, App.Callback<Void> callback)	Exclui uma chave de API específica criada pelo usuário.
void	disable(ObjectId id)	Desabilita uma chave de API específica criada pelo usuário.
RealmAsyncTask	disableAsync(ObjectId id, App.Callback<Void> callback)	Desabilita uma chave de API específica criada pelo usuário.
void	enable(ObjectId id)	Habilita uma chave de API específica criada pelo usuário.
RealmAsyncTask	enableAsync(ObjectId id, App.Callback<Void> callback)	Habilita uma chave de API específica criada pelo usuário.
boolean	equals(Object o)
ApiKey	fetch(ObjectId id)	Busca uma chave de API de usuário específica associada ao usuário.
List<ApiKey>	fetchAll()	Busca todas as chaves API associadas ao usuário.
RealmAsyncTask	fetchAll(App.Callback<List<ApiKey>> callback)	Busca todas as chaves API associadas ao usuário.
RealmAsyncTask	fetchAsync(ObjectId id, App.Callback<ApiKey> callback)	Busca uma chave de API de usuário específica associada ao usuário.
App	getApp()	Retorna o App com o qual esta instância está associada.
User	getUser()	Retorna o User com o qual esta instância está associada.
int	hashCode()
String	toString()

Métodos herdados da classe java.lang.objeto

getClass, notify, notifyAll, wait, wait, wait

Detalhes do método

getUser

utilizador público getUser ()

Retorna o User com o qual esta instância está associada.

Retorna:

O User com o qual esta instância está associada.

getApp

aplicativo público getApp()

Retorna o App com o qual esta instância está associada.

Retorna:

O App com o qual esta instância está associada.

criar

a criação de uma chave de API pública (nome da string ) lança uma exceção de aplicação

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

O valor da chave deve ser mantido neste momento, pois esta é a única vez em que ela estará visível.

A chave é habilitada quando criada. Ele pode ser desabilitado ligando para disable(ObjectId).

Parâmetros:

name - o nome da chave

Retorna:

a nova chave de API para o usuário.

Lançamentos:

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

createAsync

public RealmAsyncTask createAsync(String name,
                                  App.Callback<ApiKey> callback)

Cria de forma assíncrona uma chave de API do usuário que pode ser usada para autenticar como o usuário.

O valor da chave deve ser mantido neste momento, pois esta é a única vez em que ela estará visível.

A chave é habilitada quando criada. Ele pode ser desabilitado ligando para 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çamentos:

IllegalStateException - se chamado de um thread não loop de eventos.

buscar

a busca de Chave de API pública (ID do ObjectId ) lança AppException

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çamentos:

AppException - se o servidor não conseguir buscar a chave de API.

fetchAsync

public RealmAsyncTask fetchAsync(ObjectId id,
                                 App.Callback<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çamentos:

IllegalStateException - se chamado de um thread não loop de eventos.

fetchAll

public List<ApiKey> fetchAll()
                      throws AppException

Busca todas as chaves API associadas ao usuário.

Lançamentos:

AppException - se o servidor não conseguir buscar as chaves de API.

fetchAll

public RealmAsyncTask fetchAll(App.Callback<List<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çamentos:

IllegalStateException - se chamado de um thread não loop de eventos.

excluir

public void delete(ObjectId id)
            throws AppException

Exclui uma chave de API específica criada pelo usuário.

Parâmetros:

id - o ID da chave a ser excluída.

Lançamentos:

AppException - se o servidor não conseguir excluir a chave de API.

deleteAsync

public RealmAsyncTask deleteAsync(ObjectId id,
                                  App.Callback<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çamentos:

IllegalStateException - se chamado de um thread não loop de eventos.

desabilitar

public void disable(ObjectId id)
             throws AppException

Desabilita uma chave de API específica criada pelo usuário.

Parâmetros:

id - o ID da chave a ser desabilitada.

Lançamentos:

AppException - se o servidor não conseguir desativar a chave de API.

disableAsync

public RealmAsyncTask disableAsync(ObjectId id,
                                   App.Callback<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çamentos:

IllegalStateException - se chamado de um thread não loop de eventos.

habilitar

public void enable(ObjectId id)
            throws AppException

Habilita uma chave de API específica criada pelo usuário.

Parâmetros:

id - o ID da chave a ser habilitada.

Lançamentos:

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

enableAsync

public RealmAsyncTask enableAsync(ObjectId id,
                                  App.Callback<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çamentos:

IllegalStateException - se chamado de um thread não loop de eventos.

é igual a

boolean público igual (objeto o)

Substitui:

equals na aula Object

hashCode

public int hashCode()

Substitui:

hashCode na aula Object

toString

string pública toString()

Substitui:

toString na aula Object