/ /

/ /

SDK de Dispositivo Atlas

Java SDK

Referencia de API

io.realm.mongodb

Class User

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

io.realm.mongodb

java.lang.Object

io.realm.mongodb.User

A user holds the user's meta data and tokens for accessing Realm App functionality.The user is used to configure Synchronized Realms and gives access to calling Realm App Functions through Functions and accessing remote Realm App

Mongo Databases through a MongoClient .

Tip

App.login(Credenciales)
io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(User, String)

Nested Class Summary

Modificador y Tipo	Class and Description
`public static final`	User.State

Resumen del método

Modificador y Tipo	Método y descripción
public booleano	equals ( Object o ) Two Users are considered equal if they have the same user identity and are associated with the same app.
public String	getAccessToken () Returns the current access token for the user.
public synchronized ApiKeyAuth	getApiKeys () Devuelve un contenedor para gestionar claves API controladas por el usuario actual.
public App	getApp () Devuelve la aplicación con la que está asociado este usuario.
public Document	getCustomData () Return the custom user data associated with the user in the Realm App.
public String	getDeviceId () Returns a unique identifier for the device the user logged in to.
public Functions	getFunctions ( CodecRegistry codecRegistry ) Returns a functions manager for invoking Realm Functions with custom codec registry for encoding and decoding arguments and results.
public synchronized Functions	getFunctions () Devuelve un administrador de funciones para invocar funciones de MongoDB Realm.
public String	getId () Returns the server id of the user.
pública Lista	getIdentities () Returns a new list of the user's identities.
public synchronized MongoClient	getMongoClient ( String serviceName ) Returns a MongoClient instance for accessing documents in the database.
public UserProfile	getProfile () Returns the profile for this user.
public Credentials.Provider	getProviderType () Returns the provider type used to log the user
public synchronized Push	getPush ( String serviceName ) Devuelve la instancia Push para administrar los registros de notificaciones push.
public String	getRefreshToken () Devuelve el token de actualización actual para el usuario.
public User.State	getState () Devuelve el estado en el que se encuentra el usuario.
public int	hashCode ()
public booleano	isLoggedIn () Returns true if the user is currently logged in.
public User	linkCredentials ( Credentials credentials ) Links the current user with a new user identity represented by the given credentials.
public RealmAsyncTask	linkCredentialsAsync ( Credentials credentials, io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Links the current user with a new user identity represented by the given credentials.
public void	logOut () Log the user out of the Realm App.
public RealmAsyncTask	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.
public RealmAsyncTask	refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback ) Re-fetch custom user data from the Realm App asynchronously.
public Document	refreshCustomData () Re-fetch custom user data from the Realm App.
public User	remove () Calling this will remove the user and any Realms the user has from the device.
public RealmAsyncTask	removeAsync ( io.realm.mongodb.App.Callback<io.realm.mongodb.User> callback ) Calling this will asynchronously remove the user and any Realms the user has from the device.

Inherited Methods

Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Detalle del método

equals

public boolean equals ( Object o )
Two Users are considered equal if they have the same user identity and are associated with the same app. Anulaciones `equals` en la clase Objeto

getAccessToken

public String getAccessToken ()
Returns the current access token for the user. Devuelve the current access token.

getApiKeys

public synchronized ApiKeyAuth getApiKeys ()
Devuelve un contenedor para gestionar claves API controladas por el usuario actual. Devuelve wrapper for managing API keys controlled by the current user. Throws IllegalStateException - if no user is currently logged in.

getApp

public App getApp ()
Devuelve la aplicación con la que está asociado este usuario. Devuelve the App this user is associated with.

getCustomData

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

getDeviceId

public String getDeviceId ()
Returns a unique identifier for the device the user logged in to. Devuelve a unique device identifier for the user.

getFunctions

public Functions getFunctions ( CodecRegistry codecRegistry )
Returns a functions manager for invoking Realm Functions with custom codec registry for encoding and decoding arguments and results. Parámetros `codecRegistry` - The codec registry to use for encoding and decoding arguments and results towards the remote Realm App. 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 ()
Returns the server id of the user. Devuelve the server id of the user.

getIdentities

public List getIdentities ()
Returns a new list of the user's identities. Devuelve the list of identities. Tip UserIdentity

getMongoClient

public synchronized MongoClient getMongoClient ( String serviceName )
Returns a MongoClient instance for accessing documents in the database. Parámetros `serviceName` - el nombre del servicio utilizado para conectarse al servidor.

getProfile

public UserProfile getProfile ()
Returns the profile for this user. Devuelve the profile for this user

getProviderType

public Credentials.Provider getProviderType ()
Returns the provider type used to log the user Devuelve the provider type of the user

getPush

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 the current refresh token.

getState

public User.State getState ()
Devuelve el estado en el que se encuentra el usuario. Devuelve the State of the user.

hashCode

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

isLoggedIn

public boolean isLoggedIn ()
Returns true if the user is currently logged in. Returns whether or not this user is still logged into the MongoDB Realm App. Devuelve `true` if still logged in, `false` if not.

linkCredentials

public User linkCredentials (

Credentials credentials

)

Links the current user with a new user identity represented by the given credentials.Linking a user with more credentials, mean the user can login either of these credentials. It also makes it possible to "upgrade" an anonymous user by linking it with e.g. Email/Password credentials.

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

Note: It is not possible to link two existing users of MongoDB Realm. The provided credentials must not have been used by another user.

Parámetros

credentials - the credentials to link with the current user.

Devuelve

el Usuario al que estaban vinculadas las credenciales.

Throws

IllegalStateException - if no user is currently logged in.

linkCredentialsAsync

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"));

Note: It is not possible to link two existing users of MongoDB Realm. The provided credentials must not have been used by another user.

Parámetros

credentials - the credentials to link with the current user.
callback - callback when user identities has been linked or it 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.

logOut

public void logOut ()

Log the user out of the Realm App. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before User.remove() is called.

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.

Logging out anonymous users will remove them immediately instead of marking them as User.State.LOGGED_OUT .

All other users will be marked as User.State.LOGGED_OUT and will still be returned by App.allUsers() . They can be removed completely by calling User.remove() .

Throws

AppException - if an error occurred while trying to log the user out of the Realm App.

logOutAsync

public RealmAsyncTask logOutAsync (

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

)

Log the user out of the Realm App asynchronously. This will unregister them on the device and stop any synchronization to and from the users' Realms. Any Realms owned by the user will not be deleted from the device before User.remove() is called.

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.

Logging out anonymous users will remove them immediately instead of marking them as User.State.LOGGED_OUT .

All other users will be marked as User.State.LOGGED_OUT and will still be returned by App.allUsers() . They can be removed completely by calling User.remove() .

Parámetros

callback - función de retorno cuando cerrar sesión se ha completado o ha fallado. La función de retorno siempre ocurrirá en el mismo hilo en el que se llame este método.

Throws

IllegalStateException - if called from a non-looper thread.

refreshCustomData

public RealmAsyncTask refreshCustomData ( io.realm.mongodb.App.Callback<Document> callback )
Re-fetch custom user data from the Realm App asynchronously.This is the asynchronous variant of refreshCustomData() . Parámetros `callback` - La función de retorno que recibirá el resultado o cualquier error de la solicitud. Devuelve The task representing the ongoing operation. Throws IllegalStateException - if not called on a looper thread.

public Document refreshCustomData ()
Re-fetch custom user data from the Realm App. Devuelve The updated custom user data associated with the user. Throws AppException - si la solicitud falló de alguna manera.

Remover

public User remove ()
Calling this will remove the user and any Realms the user has from the device. No data is removed from the server. If the user is logged in when calling this method, the user is logged out before any data is deleted. Devuelve el usuario que fue eliminado. Throws AppException - if an error occurred while trying to remove the user.

removeAsync

public RealmAsyncTask removeAsync (

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

)

Calling this will asynchronously remove the user and any Realms the user has from the device. No data is removed from the server. If the user is logged in when calling this method, the user is logged out before any data is deleted.

Parámetros

callback - función de retorno cuando al eliminar el usuario se haya completado o fallado. La función de retorno siempre ocurrirá en el mismo hilo en el que se llame este método.

Throws

IllegalStateException - if called from a non-looper thread.

Volver

RealmResultTask

User.State