/ /

io.realm.mongodb.auth

Docs Home

/ /

Referencia de API

io.realm.mongodb.auth

Docs Home

MongoDB Atlas

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm.mongodb.auth

Clase ApiKeyAuth

Los SDK de dispositivos Atlas están obsoletos. Consulte Página de desuso para más detalles.

io.realm.mongodb.auth

java.lang.Object

io.realm.mongodb.auth.ApiKeyAuth

Esta clase expone la funcionalidad para que un usuario administre claves API bajo su control.

Resumen del método

Modificador y Tipo	Método y descripción
vacío abstracto protegido	call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )
clave API pública	create ( String name ) Crea una clave API de usuario que se puede utilizar para autenticarse como usuario.
Tarea asincrónica dedominio público	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.
vacío público	delete ( ObjectId id ) Elimina una clave API específica creada por el usuario.
Tarea asincrónica dedominio público	deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Elimina una clave API específica creada por el usuario.
vacío público	disable ( ObjectId id ) Deshabilita una clave API específica creada por el usuario.
Tarea asincrónica dedominio público	disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Deshabilita una clave API específica creada por el usuario.
vacío público	enable ( ObjectId id ) Habilita una clave API específica creada por el usuario.
Tarea asincrónica dedominio público	enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) Habilita una clave API específica creada por el usuario.
booleanopúblico	equals ( Object o )
clave API pública	fetch ( ObjectId id ) Obtiene una clave API de usuario específica asociada con el usuario.
Tarea asincrónica dedominio público	fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback ) Obtiene todas las claves API asociadas con el usuario.
Lista pública	fetchAll () Obtiene todas las claves API asociadas con el usuario.
Tarea asincrónica dedominio público	fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) Obtiene una clave API de usuario específica asociada con el usuario.
Aplicación pública	getApp () Devuelve la aplicación con la que esta instancia está asociada.
Usuario público	getUser () Devuelve el usuario con el que está asociada esta instancia.
entero público	hashCode ()
cadena pública	toString ()

Métodos heredados

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

Detalle del método

llamada

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.

La clave se habilita al crearse. Se puede deshabilitar llamando a la función "disable(ObjectId)".

Parámetros

name - el nombre de la clave

Devuelve

la nueva clave API para el usuario.

Lanzamientos

AppException: si el servidor no pudo crear la clave API.

crearAsync

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.

La clave se habilita al crearse. Se puede deshabilitar llamando a la función "disable(ObjectId)".

Parámetros

name - el nombre de la clave
callback - Devolución de llamada cuando la creación de la clave se ha completado o ha fallado. La devolución de llamada siempre se realizará en el mismo hilo en el que se invoque este método.

Lanzamientos

IllegalStateException: si se llama desde un hilo que no es looper.

borrar

public void delete ( ObjectId id )
Elimina una clave API específica creada por el usuario. Parámetros `id` - el id de la clave a eliminar. Lanzamientos AppException: si el servidor no pudo eliminar la clave API.

eliminarAsync

public RealmAsyncTask deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Elimina una clave API específica creada por el usuario. Parámetros `id` - el id de la clave a eliminar. `callback` - Se utiliza una devolución de llamada cuando se elimina o falla la llamada. La devolución de llamada siempre se realiza en el mismo hilo en el que se invocó este método. Lanzamientos IllegalStateException: si se llama desde un hilo que no es looper.

inhabilitar

public void disable ( ObjectId id )
Deshabilita una clave API específica creada por el usuario. Parámetros `id` - el id de la clave a deshabilitar. Lanzamientos AppException: si el servidor no pudo deshabilitar la clave API.

deshabilitarAsync

public RealmAsyncTask disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Deshabilita una clave API específica creada por el usuario. Parámetros `id` - el id de la clave a deshabilitar. `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. Lanzamientos IllegalStateException: si se llama desde un hilo que no es looper.

permitir

public void enable ( ObjectId id )
Habilita una clave API específica creada por el usuario. Parámetros `id` - el id de la clave a habilitar. Lanzamientos AppException: si el servidor no pudo habilitar la clave API.

habilitarAsync

public RealmAsyncTask enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback )
Habilita una clave API específica creada por el usuario. Parámetros `id` - el id de la clave a habilitar. `callback` - Se utiliza la devolución de llamada cuando la tecla está habilitada o la llamada falla. La devolución de llamada siempre se realizará en el mismo hilo en el que se invocó este método. Lanzamientos IllegalStateException: si se llama desde un hilo que no es looper.

equals

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

Fetch

public ApiKey fetch ( ObjectId id )
Obtiene una clave API de usuario específica asociada con el usuario. Parámetros `id` - el id de la clave a buscar. Lanzamientos AppException: si el servidor no pudo obtener la clave API.

buscarTodo

public RealmAsyncTask fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback )
Obtiene todas las claves API asociadas con el usuario. Parámetros `callback` - Se utiliza una devolución de llamada cuando se obtienen las claves o falla la llamada. La devolución de llamada siempre se realiza en el mismo hilo en el que se invocó este método. Lanzamientos IllegalStateException: si se llama desde un hilo que no es looper.

public List fetchAll ()
Obtiene todas las claves API asociadas con el usuario. Lanzamientos AppException: si el servidor no pudo obtener las claves API.

fetchAsync

public RealmAsyncTask fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback )
Obtiene una clave API de usuario específica asociada con el usuario. Parámetros `id` - el id de la clave a buscar. `callback` - Se utiliza la devolución de llamada cuando se obtiene la clave o falla la llamada. La devolución de llamada siempre se realiza en el mismo hilo en el que se invocó este método. Lanzamientos IllegalStateException: si se llama desde un hilo que no es looper.

getApp

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

getUser

public User getUser ()
Devuelve el usuario con el que está asociada esta instancia. Devuelve El usuario con el que está asociada esta instancia.

código hash

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

aCadena

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

Volver

Clave API

Correo electrónicoContraseñaAutenticación