/ /

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

Configuración de sincronización de clases

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.RealmConfiguration

io.realm.mongodb.sync.SyncConfiguration

Se utiliza una SyncConfiguration para configurar un reino que se pueda sincronizar entre dispositivos mediante MongoDB Realm.

Se requiere un Usuario válido para crear una SyncConfiguration . Consulta Credenciales y App.loginAsync(Credentials, App.función de retorno) para obtener más información sobre cómo obtener un objeto de usuario.

A continuación se encuentra una configuración de sincronización mínima.

App app = new App("app-id");
User user = app.login(Credentials.anonymous());
SyncConfiguration config = SyncConfiguration.defaultConfiguration(user, "partition-value");
Realm realm = Realm.getInstance(config);

Los reinos sincronizados solo admiten migraciones aditivas que se pueden detectar y realizar automáticamente, por lo que las siguientes opciones de creación no son accesibles en comparación con un reino normal:

deleteRealmIfMigrationNeeded()
migration(Migration)

Los reinos sincronizados se crean utilizando Realm.getInstance(RealmConfiguration) y Realm.getDefaultInstance() como los reinos no sincronizados normales.

Tip

Los documentos para obtener más información sobre la sincronización.

Resumen de clases anidadas

Modificador y Tipo	Clase y descripción
`public static interface`	Configuración de sincronización.Suscripciones de sincronización flexibles iniciales
`public static final`	SyncConfiguration.Builder

Resumen del método

Modificador y Tipo	Método y descripción
public static SyncConfiguration	defaultConfig ( User user, ObjectId partitionValue ) Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.
public static SyncConfiguration	defaultConfig ( User user, Integer partitionValue ) Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.
public static SyncConfiguration	defaultConfig ( User user, Long partitionValue ) Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.
public static SyncConfiguration	defaultConfig ( User user, String partitionValue ) Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.
public static SyncConfiguration	defaultConfig ( User user ) Devuelve una configuración Flexible Sync por defecto para el usuario dado.
booleanopúblico	equals ( Object o )
Configuración de reino estática pública	forRecovery ( String canonicalPath ) Devuelve una RealmConfiguration apropiada para abrir un Realm de solo lectura, no sincronizado para recuperar cualquier cambio pendiente.
Configuración de reino estática pública	forRecovery ( String canonicalPath, byte[] encryptionKey, java.lang.Object[] modules ) Devuelve una RealmConfiguration apropiada para abrir un Realm de solo lectura, no sincronizado para recuperar cualquier cambio pendiente.
SyncSession.ClientResetHandler público	getClientResetHandler () Devuelve el controlador de restablecimiento de cliente para esta SyncConfiguration.
SyncSession.ErrorHandler público	getErrorHandler () Devuelve el controlador de errores para esta SyncConfiguration.
Transacción dereino protegido	getInitialDataTransaction () Devuelve la instancia de transacción con datos iniciales.
public long	getInitialRemoteDataTimeout ( TimeUnit unit ) Devuelve el tiempo de espera definido al descargar cualquier dato inicial la primera vez que se abre el Reino.
Configuración de sincronización pública.Subscripciones de sincronización flexible inicial	getInitialSubscriptionsHandler () Devuelve el controlador de suscripción inicial configurado para este reino.
BsonValuepúblico	getPartitionValue () Devuelve el valor en el que está particionado este reino.
URIpública	getServerUrl () Devuelve la URI del servidor para el MongoDB Realm remoto con el que se sincroniza el Realm local.
público OsRealmConfig.SyncSessionStopPolicy	getSessionStopPolicy () NOTA: Sólo para uso interno.
Estrategia de restablecimiento decliente de sincronización pública	getSyncClientResetStrategy () Devuelve la estrategia de restablecimiento del cliente de sincronización para esta SyncConfiguration.
cadena pública	getUrlPrefix () Devuelve el prefijo de URL utilizado al establecer una conexión de sincronización con el servidor de objetos Realm.
Usuario público	getUser () Devuelve el usuario.
entero público	hashCode ()
booleanopúblico	isFlexibleSyncConfiguration () Devuelve si esta configuración es o no para abrir un Reino configurado para sincronización flexible.
booleanopúblico	isPartitionBasedSyncConfiguration () Devuelve si esta configuración es para abrir un Realm configurado para Partition-based Sync.
booleano protegido	isSyncConfiguration ()
booleano protegido	realmExists () Verifica si el archivo Realm definido por esta configuración ya existe.
booleanopúblico	shouldDeleteRealmOnLogout () Devuelve `true` si el archivo Realm debe eliminarse una vez que el usuario propietario cierra la sesión.
booleanopúblico	shouldWaitForInitialRemoteData () Devuelve `true` si el Reino descargará todos los cambios conocidos del servidor remoto antes de abrirse por primera vez.
cadena pública	toString ()

Métodos heredados

Métodos heredados de la clase getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitjava.lang.Object:,,,,,,,,,, finalize
Métodos heredados de la clase getRealmDirectorygetRealmFileNamegetEncryptionKeygetSchemaVersiongetMigrationshouldDeleteRealmIfMigrationNeededgetDurabilitygetSchemaMediatorgetInitialDataTransactionhasAssetFilegetAssetFilePathgetCompactOnLaunchCallbackgetRealmObjectClassesgetPathrealmExistsgetRxFactorygetFlowFactoryisReadOnlyisRecoveryConfigurationgetMaxNumberOfActiveVersionsisAllowWritesOnUiThreadisAllowQueriesOnUiThreadequalsgetInstancehashCodecreateSchemaMediatorio.realm.RealmConfiguration:,,,,,,,,,,,,,,,,,,,,,,,,,,,, toStringisSyncConfigurationforRecovery

Detalle del método

defaultConfig

public static SyncConfiguration defaultConfig (

User user,

ObjectId partitionValue

)

Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.

Parámetros

user - El usuario que se utilizará para acceder a la aplicación Realm.
partitionValue - El valor de la partición que identifica el reino remoto que se sincronizará.

Devuelve

la configuración predeterminada para el usuario y valor de la partición dados.

public static SyncConfiguration defaultConfig (

User user,

Integer partitionValue

)

Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.

Parámetros

user - El usuario que se utilizará para acceder a la aplicación Realm.
partitionValue - El valor de la partición que identifica el reino remoto que se sincronizará.

Devuelve

la configuración predeterminada para el usuario y valor de la partición dados.

public static SyncConfiguration defaultConfig (

User user,

Long partitionValue

)

Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.

Parámetros

user - El usuario que se utilizará para acceder a la aplicación Realm.
partitionValue - El valor de la partición que identifica el reino remoto que se sincronizará.

Devuelve

la configuración predeterminada para el usuario y valor de la partición dados.

public static SyncConfiguration defaultConfig (

User user,

String partitionValue

)

Devuelve una configuración de sincronización basada en partición predeterminada para el usuario y el valor de partición indicados.

Parámetros

user - El usuario que se utilizará para acceder a la aplicación Realm.
partitionValue - El valor de la partición que identifica el reino remoto que se sincronizará.

Devuelve

la configuración predeterminada para el usuario y valor de la partición dados.

public static SyncConfiguration defaultConfig ( User user )
Devuelve una configuración Flexible Sync por defecto para el usuario dado. Parámetros `user` - El usuario que se utilizará para acceder a la aplicación Realm. Devuelve la configuración de sincronización flexible predeterminada para el usuario determinado. Tip {@link SubscriptionSet} para obtener más información sobre Flexible Sync.

equals

public boolean equals ( Object o )
Anulaciones `equals` en la clase RealmConfiguration

para la recuperación

public static RealmConfiguration forRecovery (

String canonicalPath

)

Devuelve una RealmConfiguration adecuada para abrir un Realm de solo lectura y no sincronizado para recuperar los cambios pendientes. Esto es útil al intentar abrir un Realm de copia de seguridad/recuperación (tras reiniciar un cliente). Nota: Esto usará el módulo Realm predeterminado (compuesto por todos los RealmModel) y asumirá que no se debe usar cifrado.

Parámetros

canonicalPath - la ruta absoluta al archivo Realm definido por esta configuración.

Devuelve

Configuración de reino que se puede utilizar sin conexión

public static RealmConfiguration forRecovery (

String  canonicalPath,
byte[] encryptionKey,
java.lang.Object[]  modules

)

Devuelve una RealmConfiguration adecuada para abrir un dominio de solo lectura no sincronizado y recuperar los cambios pendientes. Esto resulta útil al intentar abrir un dominio de copia de seguridad/recuperación (tras restablecer un cliente).

Parámetros

canonicalPath - la ruta absoluta al archivo Realm definido por esta configuración.
encryptionKey - la clave utilizada para cifrar/descifrar el archivo Realm.
modules - si se especifica, restringirá el esquema de Realm al módulo proporcionado.

Devuelve

Configuración de reino que se puede utilizar sin conexión

obtenerControladorDeReinicioDeCliente

public SyncSession.ClientResetHandler getClientResetHandler ()
Devuelve el controlador de restablecimiento de cliente para esta SyncConfiguration. Devuelve El controlador de restablecimiento del cliente.

getErrorHandler

public SyncSession.ErrorHandler getErrorHandler ()
Devuelve el controlador de errores para esta SyncConfiguration. Devuelve El manejador de errores.

getInitialDataTransaction

protected Realm.Transaction getInitialDataTransaction ()
Devuelve la instancia de transacción con datos iniciales. Devuelve la transacción de datos inicial. Anulaciones `getInitialDataTransaction` en la clase RealmConfiguration

Obtener tiempo de espera de datos remotos iniciales

public long getInitialRemoteDataTimeout ( TimeUnit unit )
Devuelve el tiempo de espera definido al descargar cualquier dato inicial la primera vez que se abre Realm. Este valor solo es aplicable si shouldWaitForInitialRemoteData() `true`devuelve. Devuelve el tiempo que Realm esperará a que se descarguen todos los cambios antes de cancelarlo y lanzar una excepción. Tip SyncConfiguration.Builder.waitForInitialRemoteData(largo, unidad de tiempo)

Obtener el controlador de suscripciones iniciales

public SyncConfiguration.InitialFlexibleSyncSubscriptions getInitialSubscriptionsHandler ()
Devuelve el controlador de suscripción inicial configurado para este reino. Devuelve El controlador utilizado para configurar las suscripciones iniciales para este reino.

obtenerValorDePartición

public BsonValue getPartitionValue ()

Devuelve el valor sobre el que está particionado este Realm. La clave de partición es una propiedad definida en MongoDB Realm. Todas las clases con una propiedad con este valor se sincronizarán con el Realm.

Devuelve

el valor que utiliza MongoDB Realm para particionar la base de datos MongoDB del lado del servidor en reinos que se pueden sincronizar de forma independiente.

Lanzamientos

IllegalStateException: si esta configuración corresponde a un dominio configurado para sincronización flexible. Puede usar isPartitionBasedSyncConfiguration() antes de llamar a este método para comprobarlo.

getServerUrl

public URI getServerUrl ()
Devuelve la URI del servidor para el MongoDB Realm remoto con el que se sincroniza el Realm local. Devuelve URI que identifica el MongoDB Realm con el que está sincronizado este Realm local.

Obtener política de detención de sesión

public OsRealmConfig.SyncSessionStopPolicy getSessionStopPolicy ()
NOTA: Solo para uso interno. Puede cambiar sin previo aviso. Devuelve la política de detención de la sesión de este dominio una vez cerrado. Devuelve la política de detención utilizada por la sesión una vez que se cierra el Reino.

getSyncClientResetStrategy

public SyncClientResetStrategy getSyncClientResetStrategy ()
Devuelve la estrategia de restablecimiento del cliente de sincronización para esta SyncConfiguration. Devuelve La estrategia de reinicio del cliente de sincronización.

getUrlPrefix

public String getUrlPrefix ()
Devuelve el prefijo de URL utilizado al establecer una conexión de sincronización con el servidor de objetos Realm.

getUser

public User getUser ()
Devuelve el usuario. Devuelve el usuario.

código hash

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

Configuración de sincronización flexible

public boolean isFlexibleSyncConfiguration ()
Devuelve si esta configuración es o no para abrir un Reino configurado para sincronización flexible. Devuelve `true` Si esta configuración es para un reino de sincronización flexible, `false` si no.

Configuración de sincronización basada en particiones

public boolean isPartitionBasedSyncConfiguration ()
Devuelve si esta configuración es para abrir un Realm configurado para Partition-based Sync. Devuelve `true` Si esta configuración es para un reino de sincronización basado en partición, `false` si no.

Configuración de isSync

protected boolean isSyncConfiguration ()
Anulaciones `isSyncConfiguration` en la clase RealmConfiguration

realmExiste

protected boolean realmExists ()

Comprueba si el archivo Realm definido por esta configuración ya existe. ADVERTENCIA: Este método es solo una comprobación puntual. A menos que esté protegido por sincronización externa, otro hilo o proceso podría haber creado o eliminado el archivo Realm justo después de que este método haya regresado.

Devuelve

true si el archivo Realm existe, false en caso contrario.

Anulaciones

realmExists en la clase RealmConfiguration

shouldDeleteRealmOnLogout

public boolean shouldDeleteRealmOnLogout ()
Devuelve `true` si el archivo Realm debe eliminarse una vez que el usuario propietario cierra la sesión. Devuelve `true` si el archivo Realm debe eliminarse si el usuario cierra`false` la sesión. si se permite que el archivo permanezca.

deberíaEsperarDatosRemotosIniciales

public boolean shouldWaitForInitialRemoteData ()
Devuelve `true` si el Reino descargará todos los cambios conocidos del servidor remoto antes de abrirse por primera vez. Devuelve `true` si se descargarán todos los cambios remotos antes de poder abrir el Reino. `false` si el Reino se puede abrir inmediatamente.

aCadena

public String toString ()
Anulaciones `toString` en la clase RealmConfiguration

Volver

Estrategia de restablecimiento del cliente de sincronización

SyncConfiguration.Builder