/ /

io.realm.mongodb.sync

Docs Home

/ /

Referencia de API

io.realm.mongodb.sync

Docs Home

MongoDB Atlas

SDK de dispositivos Atlas

SDK de Java

Referencia de API

io.realm.mongodb.sync

Sesión de sincronización de clase

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

io.realm.mongodb.sync

java.lang.Object

io.realm.mongodb.sync.SyncSession

Una sesión controla cómo se sincronizan los datos entre un dominio en el dispositivo y el dominio del servidor en el servidor de objetos de dominio. Una sesión se crea abriendo una instancia de dominio mediante una configuración de sincronización. Una vez creada, la sesión continuará existiendo hasta que se cierre la aplicación o hasta que todos los subprocesos que usan esta configuración de sincronización cierren sus respectivos dominios.

Realm controla una sesión, pero puede proporcionar información adicional en caso de errores. Estos errores se transmiten en SyncSession.ErrorHandler.

Al crear una sesión, Realm establecerá una conexión con el servidor. Esta conexión está controlada por Realm y puede compartirse entre varias sesiones. Es posible obtener información sobre la conexión mediante addConnectionChangeListener(ConnectionListener) e isConnected().

La sesión en sí tiene un ciclo de vida diferente al de la conexión subyacente. El estado de la sesión se puede consultar mediante getState().

El objeto SyncSession es seguro para subprocesos.

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static final`	Estado de sesión de sincronización
`public static interface`	SyncSession.ErrorHandler
`public static interface`	SyncSession.ClientResetHandler

Resumen del método

Modificador y Tipo	Método y descripción
vacío público sincronizado	addConnectionChangeListener ( ConnectionListener listener ) Agrega un oyente que rastrea los cambios en la conexión que respalda esta sesión.
vacío público sincronizado	addDownloadProgressListener ( ProgressMode mode, ProgressListener listener ) Agrega un detector de progreso que rastrea los cambios que deben descargarse desde el servidor de objetos Realm.
vacío público sincronizado	addUploadProgressListener ( ProgressMode mode, ProgressListener listener ) Agrega un detector de progreso que rastrea los cambios que deben cargarse desde el dispositivo al servidor de objetos Realm.
booleanopúblico	downloadAllServerChanges ( long timeout, TimeUnit unit ) Al llamar a este método se bloqueará hasta que se hayan descargado y aplicado todos los cambios remotos conocidos al Reino o se alcance el tiempo de espera especificado.
vacío público	downloadAllServerChanges () Llamar a este método bloqueará hasta que se hayan descargado y aplicado todos los cambios remotos conocidos al Realm.
público SyncConfiguration	getConfiguration () Devuelve la SyncConfiguration que es responsable de controlar la sesión.
Estado de conexión público	getConnectionState () Obtenga el estado actual de la conexión utilizada por la sesión según se define en ConnectionState.
URIpública	getServerUrl () Devuelve la URI que describe el reino remoto al que esta sesión se conecta y con el que sincroniza los cambios.
sesión de sincronización pública.Estado	getState () Obtenga el estado de la sesión actual, como se define en SyncSession.State.
Usuario público	getUser () Devuelve el usuario definido por SyncConfiguration que se utiliza para conectarse a MongoDB Realm.
booleanopúblico	isConnected () Comprueba si la sesión está conectada al servidor y puede sincronizar datos.
vacío público sincronizado	removeConnectionChangeListener ( ConnectionListener listener ) Remueve una ConnectionListener previamente registrada.
vacío público sincronizado	removeProgressListener ( ProgressListener listener ) Elimina un detector de progreso.
vacío público sincronizado	start () Intenta iniciar la sesión y habilitar la sincronización con el servidor de objetos Realm.
vacío público sincronizado	stop () Detiene cualquier sincronización con el servidor de objetos Realm hasta que el Realm se vuelva a abrir después de cerrarlo por completo.
booleanopúblico	uploadAllLocalChanges ( long timeout, TimeUnit unit ) Al llamar a este método se bloqueará hasta que se hayan cargado todos los cambios locales conocidos en el servidor o se alcance el tiempo de espera especificado.
vacío público	uploadAllLocalChanges () Al llamar a este método se bloqueará hasta que todos los cambios locales conocidos se hayan cargado en el servidor.

Métodos heredados

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

Detalle del método

añadirListener de cambio de conexión

public synchronized void addConnectionChangeListener ( ConnectionListener listener )
Añade un detector que rastrea los cambios en la conexión que respalda esta sesión. Consulta ConnectionState para más detalles. Parámetros `listener` - el oyente se registre. Lanzamientos IllegalArgumentException: si el oyente `null` es. Tip Estado de conexión

añadir escucha de progreso de descarga

public synchronized void addDownloadProgressListener ( ProgressMode mode, ProgressListener listener )
Agrega un detector de progreso que rastrea los cambios que deben descargarse desde el servidor de objetos Realm. El ProgressListener se activará inmediatamente cuando se registre y periódicamente después. Parámetros `mode` - Tipo de modo utilizado.Consulte ProgressMode para más información. `listener` - el oyente se registre.

addUploadProgressListener

public synchronized void addUploadProgressListener ( ProgressMode mode, ProgressListener listener )
Agrega un detector de progreso que rastrea los cambios que deben cargarse desde el dispositivo al servidor de objetos Realm. El ProgressListener se activará inmediatamente cuando se registre y periódicamente después. Parámetros `mode` - Tipo de modo utilizado.Consulte ProgressMode para más información. `listener` - el oyente se registre.

Descargar todos los cambios del servidor

public boolean downloadAllServerChanges (

long timeout,

TimeUnit unit

)

Al llamar a este método, se bloqueará hasta que se hayan descargado y aplicado todos los cambios remotos conocidos al dominio o hasta que se alcance el tiempo de espera especificado. Esto implica acceso a la red, por lo que solo se debe llamar desde un subproceso que no sea de interfaz de usuario. No se puede llamar a este método antes de que se abra el dominio.

Devuelve

true si los datos se descargaron antes del tiempo de espera. false si la operación se agotó o falló de otro modo.

Lanzamientos

IllegalStateException: si se llama en el hilo principal de Android.
InterruptedException: si la descarga tardó más del tiempo de espera especificado o si el hilo se interrumpió durante la descarga. La descarga continuará en segundo plano incluso después de que se genere esta excepción.
IllegalArgumentException: si timeout es menor o igual que 0 unit o null es.

public void downloadAllServerChanges ()

Llamar a este método bloqueará el proceso hasta que se hayan descargado y aplicado todos los cambios remotos conocidos al dominio. Esto implica acceso a la red, por lo que solo se debe llamar desde un subproceso que no sea de interfaz de usuario. Si el dispositivo está sin conexión, es posible que este método no regrese.

Este método no se puede llamar antes de que se haya iniciado la sesión.

Lanzamientos

IllegalStateException: si se llama en el hilo principal de Android.
InterruptedException: si el hilo se interrumpió mientras la descarga estaba en progreso.

getConfiguration

public SyncConfiguration getConfiguration ()
Devuelve la SyncConfiguration que es responsable de controlar la sesión. Devuelve SyncConfiguration que define y controla esta sesión.

obtenerEstadoDeConexión

public ConnectionState getConnectionState ()
Obtenga el estado actual de la conexión utilizada por la sesión según se define en ConnectionState. Devuelve el estado de conexión utilizado por la sesión. Tip Estado de conexión

getServerUrl

public URI getServerUrl ()
Devuelve la URI que describe el reino remoto al que esta sesión se conecta y con el que sincroniza los cambios. Devuelve URI que describe el reino remoto.

getState

public SyncSession.State getState ()
Obtenga el estado de la sesión actual, como se define en SyncSession.State. Tenga en cuenta que el estado puede cambiar después de que este método regrese. Devuelve el estado de la sesión. Tip Estado de sesión de sincronización

getUser

public User getUser ()
Devuelve el usuario definido por SyncConfiguration que se utiliza para conectarse a MongoDB Realm. Devuelve Usuario utilizado para autenticar la sesión en MongoDB Realm.

está conectado

public boolean isConnected ()

Comprueba si la sesión está conectada al servidor y puede sincronizar datos. Este método es una estimación aproximada. Para ahorrar batería, la implementación subyacente utiliza latidos para detectar si la conexión sigue disponible. Por lo tanto, si no se están sincronizando datos activamente y ha transcurrido algún tiempo desde el último latido, es posible que la conexión se haya interrumpido, pero este método devolverá true .

Devuelve

true si la sesión está conectada y lista para sincronizar datos, false si no lo está o si está en proceso de conexión.

eliminarConnectionChangeListener

public synchronized void removeConnectionChangeListener ( ConnectionListener listener )
Remueve una ConnectionListener previamente registrada. Parámetros `listener` - oyente para eliminar Lanzamientos IllegalArgumentException: si el oyente `null` es.

removeProgressListener

public synchronized void removeProgressListener ( ProgressListener listener )
Elimina un detector de progreso. Si el detector no estaba registrado, este método no hará nada. Parámetros `listener` - oyente a eliminar.

Inicio

public synchronized void start ()

Intenta iniciar la sesión y habilitar la sincronización con el servidor de objetos Realm. Esto sucede automáticamente al abrir la instancia de Realm, por lo que hacerlo manualmente solo debería ser necesario si la sesión se detuvo usando stop().

Si la sesión ya se inició, llamar a este método no hará nada.

Una sesión se considera iniciada si getState() devuelve State.ACTIVE. Si la sesión es State.DYING, se reubicará en State.ACTIVE.

Tip

parada

public synchronized void stop ()
Detiene cualquier sincronización con el servidor de objetos Realm hasta que el Realm se vuelva a abrir después de cerrarlo por completo. La sincronización se puede volver a habilitar llamando a start() nuevamente. Si la sesión ya está detenida, llamar a este método no hará nada.

subirTodosLosCambiosLocales

public boolean uploadAllLocalChanges (

long timeout,

TimeUnit unit

)

Al llamar a este método, se bloqueará hasta que se hayan cargado todos los cambios locales conocidos al servidor o se alcance el tiempo de espera especificado. Esto implica acceso a la red, por lo que solo se debe llamar desde un subproceso que no sea de interfaz de usuario. No se puede llamar a este método antes de que se abra el dominio.

Devuelve

true si los datos se cargaron antes del tiempo de espera. false si la operación se agotó o falló de otro modo.

Lanzamientos

IllegalStateException: si se llama en el hilo principal de Android.
InterruptedException: si la carga tardó más del tiempo de espera especificado o si el hilo se interrumpió durante la carga. La carga continuará en segundo plano incluso después de que se genere esta excepción.
IllegalArgumentException: si timeout es menor o igual que 0 unit o null es.

public void uploadAllLocalChanges ()

Llamar a este método bloqueará hasta que todos los cambios locales conocidos se hayan subido al servidor. Esto implicará acceso a la red, por lo que solo se debe llamar a este método desde un subproceso que no sea de Interfaz de Usuario. Si el dispositivo está sin conexión, este método podría no devolver nunca una respuesta.

Este método no se puede llamar antes de que se haya abierto el Reino.

Lanzamientos

IllegalStateException: si se llama en el hilo principal de Android.
InterruptedException: si el hilo se interrumpió mientras la descarga estaba en progreso.

Volver

Configuración de sincronización.Suscripciones de sincronización flexibles iniciales

SyncSession.ClientResetHandler