/ /

/ /

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm.mongodb

Aplicación de clase

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

io.realm.mongodb

java.lang.Object

io.realm.mongodb.App

Una aplicación es el principal punto de entrada del lado del cliente para interactuar con una aplicación MongoDB Realm. La aplicación se puede utilizar para:

Registrar usos y realizar diversas operaciones relacionadas con el usuario a través de proveedores de autenticación(io.realm.mongodb.auth.ApiKeyAuth, EmailPasswordAuthImpl)
Sincronice datos entre el dispositivo local y una aplicación Realm remota con Synchronized Realms
Invocar funciones de la aplicación Realm con Funciones
Accede a datos remotos de bases de datos MongoDB con un io.realm.mongodb.mongo.MongoClient

Para crear una aplicación vinculada con una aplicación Realm remota, inicialice Realm y configure la aplicación como se muestra a continuación:

class MyApplication extends Application {
     App APP; // The App instance should be a global singleton
     @Override
     public void onCreate() {
         super.onCreate();
         Realm.init(this);
         AppConfiguration appConfiguration = new AppConfiguration.Builder(BuildConfig.MONGODB_REALM_APP_ID)
                 .appName(BuildConfig.VERSION_NAME)
                 .appVersion(Integer.toString(BuildConfig.VERSION_CODE))
                 .build();
         APP = new App(appConfiguration);
     }
 }

Tras configurar la aplicación, puede empezar a gestionar usuarios, configurar dominios sincronizados, invocar funciones remotas de dominios y acceder a datos remotos mediante colecciones de Mongo. Los ejemplos a continuación muestran las API sincronizadas que no se pueden usar desde el hilo principal. Para ver las API asíncronas equivalentes, consulte https://github.com/realm/realm-java/tree/main/examples/mongoDbRealmExample.

Para registrar un nuevo usuario y/o iniciar sesión con un usuario existente haga lo que se muestra a continuación:

// Register new user
APP.getEmailPassword().registerUser(username, password);
// Login with existing user
User user = APP.login(Credentials.emailPassword(username, password))

Con un usuario autorizado puedes sincronizar datos entre el dispositivo local y la aplicación Realm remota abriendo un Realm con io.realm.mongodb.sync.SyncConfiguration como se indica a continuación:

SyncConfiguration syncConfiguration = new SyncConfiguration.Builder(user, "<partition value>")
         .build();
Realm instance = Realm.getInstance(syncConfiguration);
SyncSession session = APP.getSync().getSession(syncConfiguration);
instance.executeTransaction(realm -> {
    realm.insert(...);
});
session.uploadAllLocalChanges();
instance.close();

Puede llamar a funciones de Realm remotas como se muestra a continuación:

Functions functions = user.getFunctions();
Integer sum = functions.callFunction("sum", Arrays.asList(1, 2, 3, 4), Integer.class);

Y acceder a las colecciones desde la aplicación Realm remota como se muestra aquí:

MongoClient client = user.getMongoClient(SERVICE_NAME)
MongoDatabase database = client.getDatabase(DATABASE_NAME)
MongoCollection<DocumentT> collection = database.getCollection(COLLECTION_NAME);
Long count = collection.count().get()

Tip

Constructores

Constructor y descripción
App ( String appId )
App ( AppConfiguration config ) Constructor para crear una aplicación según la AppConfiguration indicada.

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static`	Resultado de la aplicación
`public static interface`	Devolución de llamada de la aplicación

Resumen del campo

Modificador y Tipo	Campo y descripción
Ejecutor público estático de ThreadPool	EJECUTOR DE GRUPO DE REDES Grupo de subprocesos utilizado al realizar solicitudes de red contra MongoDB Realm. Este grupo solo se expone para fines de prueba y reemplazarlo mientras la cola no esté vacía dará como resultado un comportamiento indefinido.

Resumen del método

Modificador y Tipo	Método y descripción
vacío público	addAuthenticationListener ( AuthenticationListener listener ) Establece un detector de autenticación global que recibirá notificaciones sobre eventos de usuario, como inicio y cierre de sesión.
Mapa público	allUsers () Devuelve todos los usuarios conocidos que son User.State.LOGGED_IN o User.State.LOGGED_OUT.
Usuario público	currentUser () Devuelve el usuario actual que ha iniciado sesión y aún es válido.
booleanopúblico	equals ( Object o ) Dos aplicaciones se consideran iguales y compartirán su estado subyacente si ambas hacen referencia a la misma AppConfiguration.getAppId().
Configuración de aplicaciónpública	getConfiguration () Devuelve el objeto de configuración para esta aplicación.
Correo electrónicopúblico ContraseñaAutenticación	getEmailPassword () Devuelve un contenedor para interactuar con la funcionalidad relacionada con los usuarios creados o que iniciaron sesión mediante el proveedor de identidad Credentials.Provider.EMAIL_PASSWORD.
Funciones públicas	getFunctions ( User user, CodecRegistry codecRegistry ) Devuelve un administrador de funciones para invocar las funciones de la aplicación Realm con un registro de códec personalizado para codificar y decodificar argumentos y resultados.
Funciones públicas	getFunctions ( User user ) Devuelve un administrador de funciones para invocar las funciones de Realm de la aplicación Realm.
Sincronizaciónpública	getSync () Devuelve la instancia de sincronización que administra las sesiones de sincronización de Realm en curso y sincroniza los datos entre la aplicación de Realm local y la aplicación de Realm remota asociada con esta aplicación.
entero público	hashCode ()
Usuario público	login ( Credentials credentials ) Inicia sesión como usuario con las credenciales proporcionadas asociadas a un proveedor de autenticación.
Tarea asincrónica dedominio público	loginAsync ( Credentials credentials, io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Inicia sesión como usuario con las credenciales proporcionadas asociadas a un proveedor de autenticación.
vacío público	removeAuthenticationListener ( AuthenticationListener listener ) Elimina el escucha de autenticación global proporcionado.
Usuario público	removeUser ( User user ) Elimina las credenciales de un usuario de este dispositivo.
vacío protegido	setNetworkTransport ( OsJavaNetworkTransport transport ) Expuesto para pruebas.
Usuario público	switchUser ( User user ) Cambiar el usuario actual.

Métodos heredados

Métodos heredados de la clase getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitjava.lang.Object:,,,,,,,,,, finalize

Detalle del Campo

`NETWORK_POOL_EXECUTOR`

Grupo de subprocesos utilizado al realizar solicitudes de red contra MongoDB Realm. Este grupo solo se expone para fines de prueba y reemplazarlo mientras la cola no esté vacía dará como resultado un comportamiento indefinido.

Detalle del constructor

public App ( String appId )

public App ( AppConfiguration config )
Constructor para crear una aplicación según la AppConfiguration indicada. Parámetros `config` - La configuración que se utilizará para esta instancia de la aplicación. Tip Configuración de la aplicación.Builder

Detalle del método

addAuthenticationListener

public void addAuthenticationListener ( AuthenticationListener listener )
Establece un oyente de autenticación global que recibirá notificaciones sobre eventos de usuario, como inicio y cierre de sesión. Las devoluciones de llamadas a los oyentes de autenticación se realizarán en el hilo de la interfaz de usuario. Parámetros `listener` - oyente para registrarse. Lanzamientos IllegalArgumentException: `listener` si `null` es.

todos los usuarios

public Map allUsers ()
Devuelve todos los usuarios conocidos que son User.State.LOGGED_IN o User.State.LOGGED_OUT. Sólo se devolverán los usuarios que en algún momento iniciaron sesión en este dispositivo. Devuelve un mapa de identificadores de usuarios y usuarios conocidos localmente.

usuario actual

public User currentUser ()

Devuelve el usuario actual que ha iniciado sesión y aún es válido. Un usuario se invalida cuando cierra sesión o cuando su token de actualización caduca o se revoca.

Si dos o más usuarios han iniciado sesión, este método devuelve el último usuario válido.

Devuelve

Usuario actual que ha iniciado sesión y aún es válido. null si ningún usuario ha iniciado sesión o el usuario ha expirado.

equals

public boolean equals ( Object o )
Dos aplicaciones se consideran iguales y compartirán su estado subyacente si ambas hacen referencia a la misma AppConfiguration.getAppId(). Anulaciones `equals` en la clase Objeto

getConfiguration

public AppConfiguration getConfiguration ()
Devuelve el objeto de configuración para esta aplicación. Devuelve La configuración de esta aplicación.

obtenerContraseña de correo electrónico

public EmailPasswordAuth getEmailPassword ()
Devuelve un contenedor para interactuar con la funcionalidad relacionada con los usuarios creados o que iniciaron sesión mediante el proveedor de identidad Credentials.Provider.EMAIL_PASSWORD. Devuelve contenedor para interactuar con el proveedor de identidad Credentials.Provider.EMAIL_PASSWORD.

obtenerFunciones

public Functions getFunctions ( User user, CodecRegistry codecRegistry )
Devuelve un administrador de funciones para invocar las funciones de la aplicación Realm con un registro de códec personalizado para codificar y decodificar argumentos y resultados. Tip Funciones

public Functions getFunctions ( User user )
Devuelve un Administrador de funciones para invocar las funciones de Realm de la aplicación Realm. Esto usará el registro de códecs por defecto de la aplicación para codificar y decodificar argumentos y resultados. Tip Funciones Configuración de la aplicación.getDefaultCodecRegistry()

obtener sincronización

public Sync getSync ()
Devuelve la instancia de sincronización que administra las sesiones de sincronización de Realm en curso y sincroniza los datos entre la aplicación de Realm local y la aplicación de Realm remota asociada con esta aplicación. Devuelve la instancia de sincronización asociada con esta aplicación.

código hash

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

login

public User login (

Credentials credentials

)

Inicia sesión como un usuario con las credenciales proporcionadas asociadas a un proveedor de autenticación. El usuario que inicia sesión se convierte en el usuario actual. Otras funciones de la aplicación actúan en nombre del usuario actual.

Si ya existe un usuario activo, ese usuario sigue ha iniciado sesión y se puede encontrar en la lista devuelta por allUsers() .

También es posible cambiar entre qué usuario se considera el usuario actual utilizando switchUser(User).

Parámetros

credentials - las credenciales que representan el tipo de inicio de sesión.

Devuelve

un usuario que representa al usuario conectado.

Lanzamientos

AppException: si el usuario no pudo iniciar sesión.

loginAsync

public RealmAsyncTask loginAsync (

Credentials credentials,

io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback

)

Si ya existe un usuario activo, ese usuario sigue ha iniciado sesión y se puede encontrar en la lista devuelta por allUsers() .

También es posible cambiar entre qué usuario se considera el usuario actual utilizando switchUser(User).

Parámetros

credentials - las credenciales que representan el tipo de inicio de sesión.
callback - Devolución de llamada cuando el inicio de sesión se completa o falla. La devolución de llamada siempre se realizará en el mismo hilo en el que se invoque este método.

Lanzamientos

IllegalStateException: si no se llama en un hilo de bucle.

removeAuthenticationListener

public void removeAuthenticationListener ( AuthenticationListener listener )
Elimina el escucha de autenticación global proporcionado. Parámetros `listener` - oyente a eliminar.

eliminarUsuario

public User removeUser (

User user

)

Elimina las credenciales de un usuario de este dispositivo. Si el usuario tenía la sesión iniciada, se cerrará como parte del proceso. Este cambio es solo local y no afecta el estado del usuario en el servidor.

Parámetros

user - eliminar

Devuelve

usuario que fue eliminado.

Lanzamientos

AppException: si se llama desde el hilo de UI o si el usuario inició sesión, pero no pudo cerrarla.

establecerTransporteDeRed

protected void setNetworkTransport ( OsJavaNetworkTransport transport )
Expuesto para pruebas. Intercambie el transporte de red configurado actualmente con el proporcionado. Esto solo debe hacerse si no hay solicitudes de red en ejecución.

cambiar de usuario

public User switchUser ( User user )
Cambiar el usuario actual. El usuario actual es el usuario devuelto por currentUser(). Parámetros `user` - el nuevo usuario actual. Lanzamientos IllegalArgumentException: si el usuario no es User.State.LOGGED_IN.

Volver

io.realm.mongodb

Devolución de llamada de la aplicación