/ /

/ /

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm.mongodb

Usuario 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.User

Un usuario contiene los metadatos y tokens del usuario para acceder a la funcionalidad de la aplicación Realm. El usuario se utiliza para configurar Realms sincronizados y da acceso para llamar a las funciones de la aplicación Realm a través de Funciones y acceder a la aplicación Realm remota.

Bases de datos Mongo a través de un MongoClient.

Tip

App.login(Credenciales)
io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(Usuario, Cadena)

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static final`	Usuario.Estado

Resumen del método

Modificador y Tipo	Método y descripción
booleanopúblico	equals ( Object o ) Dos usuarios se consideran iguales si tienen la misma identidad de usuario y están asociados a la misma aplicación.
cadena pública	getAccessToken () Devuelve el token de acceso actual del usuario.
ApiKeyAuthpúblico sincronizado	getApiKeys () Devuelve un contenedor para gestionar claves API controladas por el usuario actual.
Aplicación pública	getApp () Devuelve la aplicación con la que está asociado este usuario.
Documento público	getCustomData () Devuelve los datos de usuario personalizados asociados con el usuario en la aplicación Realm.
cadena pública	getDeviceId () Devuelve un identificador único para el dispositivo en el que el usuario inició sesión.
Funciones públicas	getFunctions ( CodecRegistry codecRegistry ) Devuelve un administrador de funciones para invocar funciones de Realm con un registro de códec personalizado para codificar y decodificar argumentos y resultados.
Funcionespúblicas sincronizadas	getFunctions () Devuelve un administrador de funciones para invocar funciones de MongoDB Realm.
cadena pública	getId () Devuelve el ID del servidor del usuario.
Lista pública	getIdentities () Devuelve una nueva lista de identidades del usuario.
MongoClientpúblico sincronizado	getMongoClient ( String serviceName ) Devuelve una instancia de MongoClient para acceder a documentos en la base de datos.
perfil de usuario público	getProfile () Devuelve el perfil de este usuario.
Credenciales públicas.Proveedor	getProviderType () Devuelve el tipo de proveedor utilizado para registrar al usuario.
Pushpúblico sincronizado	getPush ( String serviceName ) Devuelve la instancia Push para administrar los registros de notificaciones push.
cadena pública	getRefreshToken () Devuelve el token de actualización actual para el usuario.
Usuario público.Estado	getState () Devuelve el estado en el que se encuentra el usuario.
entero público	hashCode ()
booleanopúblico	isLoggedIn () Devuelve verdadero si el usuario está actualmente conectado.
Usuario público	linkCredentials ( Credentials credentials ) Vincula al usuario actual con una nueva identidad de usuario representada por las credenciales proporcionadas.
Tarea asincrónica dedominio público	linkCredentialsAsync ( Credentials credentials, io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Vincula al usuario actual con una nueva identidad de usuario representada por las credenciales proporcionadas.
vacío público	logOut () Cerrar la sesión del usuario en la aplicación Realm.
Tarea asincrónica dedominio público	logOutAsync ( io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Cerrar la sesión del usuario de la Aplicación Realm de forma asíncrona.
Tarea asincrónica dedominio público	refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback ) Recupere datos de usuario personalizados desde la aplicación Realm de forma asincrónica.
Documento público	refreshCustomData () Vuelva a recuperar datos de usuario personalizados desde la aplicación Realm.
Usuario público	remove () Al llamar a esto se eliminará al usuario y cualquier Reino que tenga el usuario del dispositivo.
Tarea asincrónica dedominio público	removeAsync ( io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Al llamar a esto, se eliminará de forma asincrónica al usuario y cualquier reino que tenga el usuario del dispositivo.

Métodos heredados

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

Detalle del método

equals

public boolean equals ( Object o )
Dos usuarios se consideran iguales si tienen la misma identidad de usuario y están asociados a la misma aplicación. Anulaciones `equals` en la clase Objeto

getAccessToken

public String getAccessToken ()
Devuelve el token de acceso actual del usuario. Devuelve el token de acceso actual.

obtenerApiKeys

public synchronized ApiKeyAuth getApiKeys ()
Devuelve un contenedor para gestionar claves API controladas por el usuario actual. Devuelve contenedor para administrar claves API controladas por el usuario actual. Lanzamientos IllegalStateException: si ningún usuario ha iniciado sesión actualmente.

getApp

public App getApp ()
Devuelve la aplicación con la que está asociado este usuario. Devuelve La aplicación con la que está asociado este usuario.

getCustomData

public Document getCustomData ()
Devuelve los datos de usuario personalizados asociados con el usuario en la aplicación Realm. Los datos solo se actualizan cuando se actualiza el token de acceso del usuario o cuando se llama explícitamente a refreshCustomData(). Devuelve Los datos de usuario personalizados asociados con el usuario.

getDeviceId

public String getDeviceId ()
Devuelve un identificador único para el dispositivo en el que el usuario inició sesión. Devuelve un identificador de dispositivo único para el usuario.

obtenerFunciones

public Functions getFunctions ( CodecRegistry codecRegistry )
Devuelve un administrador de funciones para invocar funciones de Realm con un registro de códec personalizado para codificar y decodificar argumentos y resultados. Parámetros `codecRegistry` - El registro de códec que se utilizará para codificar y decodificar argumentos y resultados hacia la aplicación Realm remota. Tip Funciones

public synchronized Functions getFunctions ()
Devuelve un administrador de funciones para invocar funciones de MongoDB Realm. Esto utilizará el registro de códec predeterminado de la aplicación asociada para codificar y decodificar argumentos y resultados. Tip Funciones

getId

public String getId ()
Devuelve el ID del servidor del usuario. Devuelve el ID del servidor del usuario.

obtenerIdentidades

public List getIdentities ()
Devuelve una nueva lista de identidades del usuario. Devuelve la lista de identidades. Tip Identidad del usuario

obtenerMongoClient

public synchronized MongoClient getMongoClient ( String serviceName )
Devuelve una instancia de MongoClient para acceder a documentos en la base de datos. Parámetros `serviceName` - el nombre del servicio utilizado para conectarse al servidor.

getProfile

public UserProfile getProfile ()
Devuelve el perfil de este usuario. Devuelve el perfil de este usuario

obtenerTipoDeProveedor

public Credentials.Provider getProviderType ()
Devuelve el tipo de proveedor utilizado para registrar al usuario. Devuelve el tipo de proveedor del usuario

obtenerPush

public synchronized Push getPush ( String serviceName )
Devuelve la instancia Push para administrar los registros de notificaciones push. Parámetros `serviceName` - el nombre del servicio utilizado para conectarse al servidor.

getRefreshToken

public String getRefreshToken ()
Devuelve el token de actualización actual para el usuario. Devuelve el token de actualización actual.

getState

public User.State getState ()
Devuelve el estado en el que se encuentra el usuario. Devuelve El estado del usuario.

código hash

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

isLoggedIn

public boolean isLoggedIn ()
Devuelve verdadero si el usuario está actualmente conectado. Devuelve si este usuario todavía está conectado o no a la aplicación MongoDB Realm. Devuelve `true` Si todavía está conectado, `false` si no.

Credenciales de enlace

public User linkCredentials (

Credentials credentials

)

Vincula al usuario actual con una nueva identidad representada por las credenciales proporcionadas. Vincular a un usuario con más credenciales significa que puede iniciar sesión con cualquiera de ellas. También permite actualizar un usuario anónimo vinculándolo con, por ejemplo, credenciales de correo electrónico y contraseña.

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

Nota: No es posible vincular dos usuarios existentes de MongoDB Realm. Las credenciales proporcionadas no deben haber sido utilizadas por otro usuario.

Parámetros

credentials - las credenciales para vincularse con el usuario actual.

Devuelve

El usuario al que se vincularon las credenciales.

Lanzamientos

IllegalStateException: si ningún usuario ha iniciado sesión actualmente.

Credenciales de enlace asíncronas

public RealmAsyncTask linkCredentialsAsync (

Credentials credentials,

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

)

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

Nota: No es posible vincular dos usuarios existentes de MongoDB Realm. Las credenciales proporcionadas no deben haber sido utilizadas por otro usuario.

Parámetros

credentials - las credenciales para vincularse con el usuario actual.
callback - Devolución de llamada cuando se vinculan las identidades de usuario o falla la ejecución. 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.

cerrar sesión

public void logOut ()

Cierre la sesión del usuario en la app Realm. Esto cancelará su registro en el dispositivo y detendrá la sincronización con sus Realms. Los Realms que pertenezcan al usuario no se eliminarán del dispositivo antes de ejecutar User.remove().

Una vez que la aplicación Realm ha confirmado el cierre de sesión, cualquier AuthenticationListener registrado será notificado y las credenciales del usuario se borrarán de este dispositivo.

Al cerrar la sesión de usuarios anónimos, estos se eliminarán inmediatamente en lugar de marcarlos como User.State.LOGGED_OUT.

Todos los demás usuarios se marcarán como User.State.LOGGED_OUT y App.allUsers() los devolverá. Pueden eliminarse completamente llamando a User.remove().

Lanzamientos

AppException: si ocurrió un error al intentar cerrar la sesión del usuario en la aplicación Realm.

cierre de sesión asíncrono

public RealmAsyncTask logOutAsync (

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

)

Cierre la sesión del usuario de la aplicación Realm de forma asincrónica. Esto cancelará su registro en el dispositivo y detendrá la sincronización con sus Realms. Los Realms que sean propiedad del usuario no se eliminarán del dispositivo antes de ejecutar User.remove().

Una vez que la aplicación Realm ha confirmado el cierre de sesión, cualquier AuthenticationListener registrado será notificado y las credenciales del usuario se borrarán de este dispositivo.

Al cerrar la sesión de usuarios anónimos, estos se eliminarán inmediatamente en lugar de marcarlos como User.State.LOGGED_OUT.

Todos los demás usuarios se marcarán como User.State.LOGGED_OUT y App.allUsers() los devolverá. Pueden eliminarse completamente llamando a User.remove().

Parámetros

callback - Devolución de llamada cuando el cierre 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 se llama desde un hilo que no es looper.

actualizarCustomData

public RealmAsyncTask refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback )
Recupere datos de usuario personalizados de la aplicación Realm de forma asincrónica. Esta es la variante asincrónica de refreshCustomData(). Parámetros `callback` - La devolución de llamada que recibirá el resultado o cualquier error de la solicitud. Devuelve La tarea que representa la operación en curso. Lanzamientos IllegalStateException: si no se llama en un hilo de bucle.

public Document refreshCustomData ()
Vuelva a recuperar datos de usuario personalizados desde la aplicación Realm. Devuelve Los datos de usuario personalizados actualizados asociados con el usuario. Lanzamientos AppException: si la solicitud falló de alguna manera.

Remover

public User remove ()
Al llamar a este método, se eliminará al usuario y cualquier dominio que tenga del dispositivo. No se eliminan datos del servidor. Si el usuario tiene la sesión iniciada al llamar a este método, se cerrará la sesión antes de eliminar los datos. Devuelve el usuario que fue eliminado. Lanzamientos AppException: si ocurrió un error al intentar eliminar el usuario.

eliminarAsync

public RealmAsyncTask removeAsync (

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

)

Al llamar a este método, se eliminará asincrónicamente del dispositivo al usuario y cualquier dominio que tenga. No se eliminan datos del servidor. Si el usuario tiene la sesión iniciada al llamar a este método, se cerrará la sesión antes de eliminar los datos.

Parámetros

callback - Devolución de llamada cuando la eliminación del usuario 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 se llama desde un hilo que no es looper.

Volver

Tarea de resultados del reino

Usuario.Estado