/ /

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

Conjunto de suscripciones de interfaz

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

io.realm.mongodb.sync

Interfaces implementadas:

java.lang.Iterable

Un conjunto de suscripciones es una vista inmutable de todas las suscripciones actuales para un reino determinado que se ha configurado para una sincronización flexible.

La sincronización flexible permite definir qué datos se sincronizan hacia y desde el dispositivo mediante RealmQuery. La consulta y sus metadatos se representan mediante una suscripción.

Un conjunto de suscripciones define todos los datos disponibles para el dispositivo y que se sincronizan con el servidor. Si el conjunto de suscripciones detecta un error, por ejemplo, al contener una consulta no válida, todo el conjunto entrará en el estado SubscriptionSet.State.ERROR y no se realizará ninguna sincronización hasta que se corrija el error.

Si se elimina una suscripción, también se eliminan los datos correspondientes, pero solo se eliminan del dispositivo. No se eliminan del servidor.

Es posible modificar un conjunto de suscripciones sin conexión, pero el servidor no acepta la modificación antes de que getState() devuelva SubscriptionSet.State.COMPLETE.

Es posible forzar la sincronización del conjunto de suscripciones con el servidor mediante waitForSynchronization() y sus variantes.

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static final`	Conjunto de suscripción.Estado
`public static interface`	Conjunto de suscripciones.UpdateCallback
`public static interface`	Conjunto de suscripciones.UpdateAsyncCallback
`public static interface`	Conjunto de suscripciones.Devolución de llamada de cambio de estado

Resumen del método

Modificador y Tipo	Método y descripción
Suscripción pública	find ( String name ) Encuentra la suscripción con un nombre determinado.
Suscripción pública	find ( io.realm.RealmQuery query ) Encuentre la primera suscripción que contenga la consulta dada.
cadena pública	getErrorMessage () Si getState() devuelve State.ERROR, este método devolverá el motivo.
Conjuntode suscripciones públicas.Estado	getState () Devuelve el estado actual del SubscriptionSet.
entero público	size () Devuelve cuántas suscripciones hay actualmente en este conjunto de suscripciones.
conjunto de suscripciones públicas	update ( SubscriptionSet.UpdateCallback action ) Modificar el conjunto de suscripciones.
Tarea asincrónica dedominio público	updateAsync ( SubscriptionSet.UpdateAsyncCallback callback ) Modificar asincrónicamente el conjunto de suscripciones.
booleanopúblico	waitForSynchronization ( Long timeOut, TimeUnit unit ) Espere a que el conjunto de suscripciones se sincronice con el servidor.
booleanopúblico	waitForSynchronization () Espere a que el conjunto de suscripciones se sincronice con el servidor.
Tarea asincrónica dedominio público	waitForSynchronizationAsync ( Long timeOut, TimeUnit unit, SubscriptionSet.StateChangeCallback callback ) Espere de forma asincrónica a que el conjunto de suscripciones se sincronice con el servidor.
Tarea asincrónica dedominio público	waitForSynchronizationAsync ( SubscriptionSet.StateChangeCallback callback ) Espere de forma asincrónica a que el conjunto de suscripciones se sincronice con el servidor.

Métodos heredados

Detalle del método

buscar

public Subscription find ( String name )
Encuentra la suscripción con un nombre determinado. Parámetros `name` - nombre de la suscripción para buscar. Devuelve la suscripción coincidente o `null` si no se encontró ninguna suscripción con ese nombre.

public Subscription find ( io.realm.RealmQuery query )
Encuentra la primera suscripción que contiene la consulta dada. Es posible que varias suscripciones con nombre contengan la misma consulta. Parámetros `query` - consulta a buscar. Devuelve la primera suscripción que contiene la consulta o `null` si no se encontró ninguna coincidencia.

getErrorMessage

public String getErrorMessage ()
Si getState() devuelve State.ERROR, este método mostrará el motivo. Los errores se pueden corregir modificando la suscripción según corresponda y luego llamando a waitForSynchronization(). Devuelve El error subyacente si el conjunto de suscripciones se encuentra en el estado State.ERROR. Para todos los demás estados,`null` se devolverá.

getState

public SubscriptionSet.State getState ()
Devuelve el estado actual del SubscriptionSet. Consulte SubscriptionSet.State para obtener más información sobre cada estado. Devuelve estado actual del SubscriptionSet.

tamaño

public int size ()
Devuelve cuántas suscripciones hay actualmente en este conjunto de suscripciones. Devuelve el número de suscripciones en el conjunto de suscripciones.

update

public SubscriptionSet update (

SubscriptionSet.UpdateCallback action

)

Modifique el conjunto de suscripciones. Si se genera una excepción durante la actualización, no se aplicarán los cambios. Si la actualización se realiza correctamente, este conjunto de suscripciones se actualiza con el estado modificado.

Parámetros

action El bloque que modifica el conjunto de suscripciones. Se ejecutará en el hilo de llamada.

Devuelve

este conjunto de suscripción, que ahora ha sido actualizado.

Lanzamientos

Excepción: cualquier excepción lanzada durante la actualización se propagará hacia atrás.

updateAsync

public RealmAsyncTask updateAsync ( SubscriptionSet.UpdateAsyncCallback callback )
Modificar asincrónicamente el conjunto de suscripciones. Si se genera una excepción durante la actualización, no se aplicarán los cambios. * Parámetros `callback` - Devolución de llamada que controla la solicitud asincrónica. El éxito o el fracaso se informarán aquí. Devuelve Tarea que controla la ejecución asincrónica.

esperarSincronización

public boolean waitForSynchronization (

Long timeOut,

TimeUnit unit

)

Espere a que el conjunto de suscripciones se sincronice con el servidor. Regresará cuando el servidor acepte el conjunto de consultas y haya descargado los datos correspondientes, o si se ha producido un error. Tenga en cuenta que deberá llamar manualmente a Realm.refresh() o esperar a que se activen los detectores de cambios para ver los datos descargados. Si se produjo un error, puede encontrar la causa subyacente mediante getErrorMessage().

Parámetros

timeOut - cuánto tiempo esperar a que la sincronización tenga éxito o falle.
unit - unidad de tiempo utilizada para el tiempo de espera.

Devuelve

true si el servidor aceptó todas las suscripciones actuales y se descargaron los datos, o false si ocurrió un error.

Lanzamientos

RuntimeException: si se excede el tiempo de espera.

public boolean waitForSynchronization ()

Devuelve

true si el servidor aceptó todas las suscripciones actuales y se descargaron los datos, o false si ocurrió un error.

esperarSincronizaciónAsync

public RealmAsyncTask waitForSynchronizationAsync (

Long  timeOut,
TimeUnit  unit,
SubscriptionSet.StateChangeCallback  callback

)

Espera asincrónicamente a que el conjunto de suscripciones se sincronice con el servidor. La devolución de llamada se invoca cuando el servidor acepta el conjunto de consultas y ha descargado los datos correspondientes, o si se produce un error. Ten en cuenta que deberás llamar manualmente a Realm.refresh() o esperar a que los detectores de cambios se activen para ver los datos descargados. Si se produjo un error, la causa subyacente se puede encontrar mediante getErrorMessage().

Parámetros

timeOut - cuánto tiempo esperar a que la sincronización tenga éxito o falle.
unit - unidad de tiempo utilizada para el tiempo de espera.
callback - Devolución de llamada que se activa cuando la sincronización es exitosa o fallida. Los resultados se informarán en el hilo de la interfaz de usuario.

Devuelve

true si el servidor aceptó todas las suscripciones actuales y se descargaron los datos, o false si ocurrió un error.

public RealmAsyncTask waitForSynchronizationAsync (

SubscriptionSet.StateChangeCallback callback

)

Esperar asincrónicamente a que el conjunto de suscripciones se sincronice con el servidor. Se invocará la devolución de llamada cuando el servidor acepte el conjunto de consultas y haya descargado los datos correspondientes, o si se produce un error. Tenga en cuenta que deberá llamar manualmente a Realm.refresh() o esperar a que se activen los detectores de cambios para ver los datos descargados. Si se produjo un error, la causa subyacente se puede encontrar mediante getErrorMessage().

Parámetros

callback - Devolución de llamada que se activa cuando la sincronización es exitosa o fallida. Los resultados se informarán en el hilo de la interfaz de usuario.

Devuelve

true si el servidor aceptó todas las suscripciones actuales y se descargaron los datos, o false si ocurrió un error.

Volver

Suscripción

Conjunto de suscripción.Estado