/ /

io.realm.mongodb.auth

Docs Home

/ /

Referencia de API

io.realm.mongodb.auth

Docs Home

MongoDB Atlas

SDK de Dispositivo Atlas

Java SDK

Referencia de API

io.realm.mongodb.auth

Class ApiKeyAuth

Los SDK de dispositivos Atlas están obsoletos. Consulte deprecation page for details.

io.realm.mongodb.auth

java.lang.Object

io.realm.mongodb.auth.ApiKeyAuth

This class exposes functionality for a user to manage API keys under their control.

Resumen del método

Modificador y Tipo	Método y descripción
protected abstract void	call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )
public ApiKey	create ( String name ) Creates a user API key that can be used to authenticate as the user.
public RealmAsyncTask	createAsync ( String name, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Crea de forma asíncrona una clave de API de usuario que puede utilizarse para autenticar como usuario.
public void	delete ( ObjectId id ) Deletes a specific API key created by the user.
public RealmAsyncTask	deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Deletes a specific API key created by the user.
public void	disable ( ObjectId id ) Disables a specific API key created by the user.
public RealmAsyncTask	disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Disables a specific API key created by the user.
public void	enable ( ObjectId id ) Enables a specific API key created by the user.
public RealmAsyncTask	enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Enables a specific API key created by the user.
public booleano	equals ( Object o )
public ApiKey	fetch ( ObjectId id ) Fetches a specific user API key associated with the user.
public RealmAsyncTask	fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback ) Fetches all API keys associated with the user.
pública Lista	fetchAll () Fetches all API keys associated with the user.
public RealmAsyncTask	fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Fetches a specific user API key associated with the user.
public App	getApp () Devuelve la aplicación con la que esta instancia está asociada.
public User	getUser () Returns the User that this instance in associated with.
public int	hashCode ()
public String	toString ()

Inherited Methods

Métodos heredados de la clase java.lang.Object: getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Detalle del método

llamar

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

Cree

public ApiKey create (

String name

)

Crea una clave API de usuario que se puede utilizar para autenticarse como usuario. El valor de la clave debe conservarse en este momento, ya que es el único momento en que es visible.

The key is enabled when created. It can be disabled by calling disable(ObjectId) .

Parámetros

name - the name of the key

Devuelve

the new API key for the user.

Throws

AppException - si el servidor no pudo crear la API Key.

createAsync

public RealmAsyncTask createAsync (

String name,

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

)

Crea de forma asincrónica una clave API de usuario que se puede utilizar para autenticarse como usuario. El valor de la clave debe conservarse en este momento, ya que es el único momento en que es visible.

The key is enabled when created. It can be disabled by calling disable(ObjectId) .

Parámetros

name - the name of the key
callback - callback when key creation has completed or failed. The callback will always happen on the same thread as this method is called on.

Throws

IllegalStateException - if called from a non-looper thread.

borrar

public void delete ( ObjectId id )
Deletes a specific API key created by the user. Parámetros `id` - the id of the key to delete. Throws AppException - if the server failed to delete the API key.

deleteAsync

public RealmAsyncTask deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Deletes a specific API key created by the user. Parámetros `id` - the id of the key to delete. `callback` - callback used when the was deleted or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

inhabilitar

public void disable ( ObjectId id )
Disables a specific API key created by the user. Parámetros `id` - la id de la clave a desactivar. Throws AppException: si el servidor no pudo deshabilitar la clave API.

desactivarAsync

public RealmAsyncTask disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Disables a specific API key created by the user. Parámetros `id` - la id de la clave a desactivar. `callback` - función de retorno utilizada cuando la clave fue deshabilitada o la llamada falló. La función de retorno siempre ocurrirá en el mismo hilo en el que se llamó a este método. Throws IllegalStateException - if called from a non-looper thread.

Activar

public void enable ( ObjectId id )
Enables a specific API key created by the user. Parámetros `id` - el id de la clave a habilitar. Throws AppException: si el servidor no pudo habilitar la clave API.

enableAsync

public RealmAsyncTask enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Enables a specific API key created by the user. Parámetros `id` - el id de la clave a habilitar. `callback` - callback used when the key was enabled or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

equals

public boolean equals ( Object o )
Anulaciones `equals` en la clase Objeto

obtener

public ApiKey fetch ( ObjectId id )
Fetches a specific user API key associated with the user. Parámetros `id` - the id of the key to fetch. Throws AppException: si el servidor no pudo obtener la clave API.

fetchAll

public RealmAsyncTask fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback )
Fetches all API keys associated with the user. Parámetros `callback` - callback used when the keys were fetched or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

public List fetchAll ()
Fetches all API keys associated with the user. Throws AppException: si el servidor no pudo obtener las claves de API.

fetchAsync

public RealmAsyncTask fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback )
Fetches a specific user API key associated with the user. Parámetros `id` - the id of the key to fetch. `callback` - callback used when the key was fetched or the call failed. The callback will always happen on the same thread as this method was called on. Throws IllegalStateException - if called from a non-looper thread.

getApp

public App getApp ()
Devuelve la aplicación con la que esta instancia está asociada. Devuelve La aplicación con la que esta instancia está asociada.

getUser

public User getUser ()
Returns the User that this instance in associated with. Devuelve El usuario con el que está asociada esta instancia.

hashCode

public int hashCode ()
Anulaciones `hashCode` en la clase Objeto

toString

public String toString ()
Anulaciones `toString` en la clase Objeto

Volver

ApiKey

EmailPasswordAuth