/ /

SDK para Java

Referência da API

io.realm.mongodb.sync

Class SyncConfiguration

Os Atlas Device SDKs estão obsoletos. Consulte a página de depreciação para obter detalhes.

io.realm.mongodb.sync

java.lang.Object

io.realm.RealmConfiguration

io.realm.mongodb.sync.SyncConfiguration

Uma SyncConfiguration é usada para configurar um Realm que pode ser sincronizado entre dispositivos usando o MongoDB Realm.

Um usuário válido é necessário para criar um SyncConfiguration . Consulte Credentials and App.loginAsync(Credentials, App.Callback) para obter mais informações sobre como obter um objeto de usuário.

Uma SyncConfiguration mínima pode ser encontrada abaixo.

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

Os Realms sincronizados suportam apenas migrações aditivas que podem ser detectadas e executadas automaticamente, portanto, as seguintes opções do construtor não são acessíveis em comparação com um Realm normal:

deleteRealmIfMigrationNeeded()
migration(Migration)

Os domínios sincronizados são criados usando Realm.getInstance(RealmConfiguration) e Realm.getDefaultInstance() como realms não sincronizados comuns.

Veja também:

Os Docs para obter mais informações sobre sincronização.

Resumo da classe aninhada

Modificador e tipo	Classe e descrição
`public static interface`	SyncConfiguration.InitialFlexibleSyncSubscriptions
`public static final`	SyncConfiguration.Builder

Resumo do método

Modificador e tipo	Método e descrição
SyncConfiguration pública estática	defaultConfig ( User user, ObjectId partitionValue ) Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.
SyncConfiguration pública estática	defaultConfig ( User user, Integer partitionValue ) Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.
SyncConfiguration pública estática	defaultConfig ( User user, Long partitionValue ) Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.
SyncConfiguration pública estática	defaultConfig ( User user, String partitionValue ) Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.
SyncConfiguration pública estática	defaultConfig ( User user ) Retorna uma configuração padrão do Flexible Sync para o usuário fornecido.
booleanopúblico	equals ( Object o )
public static RealmConfiguration	forRecovery ( String canonicalPath ) Retorna uma RealmConfiguration apropriada para abrir um Realm somente leitura e não sincronizado para recuperar quaisquer alterações pendentes.
public static RealmConfiguration	forRecovery ( String canonicalPath, byte[] encryptionKey, java.lang.Object[] modules ) Retorna uma RealmConfiguration apropriada para abrir um Realm somente leitura e não sincronizado para recuperar quaisquer alterações pendentes.
public SyncSession.ClientResetHandler	getClientResetHandler () Retorna o manipulador de redefinição do cliente para este SyncConfiguration.
SyncSession.ErrorHandlerpúblico	getErrorHandler () Retorna o manipulador de erros para este SyncConfiguration.
Realm.Transactionprotegida	getInitialDataTransaction () Retorna a instância da transação com dados iniciais.
público longo	getInitialRemoteDataTimeout ( TimeUnit unit ) Retorna o tempo limite definido ao baixar quaisquer dados iniciais na primeira vez que o Realm é aberto.
public SyncConfiguration.InitialFlexibleSyncSubscriptions	getInitialSubscriptionsHandler () Retorna o manipulador de assinatura inicial configurado para este Realm.
public BsonValue	getPartitionValue () Retorna o valor em que este Realm é particionado.
public URI	getServerUrl () Retorna o URI do servidor para o MongoDB Realm remoto com o qual o Realm local está sincronizando.
public OsRealmConfig.SyncSessionStopPolicy	getSessionStopPolicy () OBSERVAÇÃO: apenas para uso interno.
SyncClientResetStrategypúblico	getSyncClientResetStrategy () Retorna a estratégia de redefinição do cliente de sincronização para este SyncConfiguration.
public String	getUrlPrefix () Retorna o prefixo da URL usado ao estabelecer uma conexão de sincronização com o servidor de Objeto de Realm.
usuáriopúblico	getUser () Retorna o usuário.
public int	hashCode ()
booleanopúblico	isFlexibleSyncConfiguration () Retorna se essa configuração é ou não para abrir um Realm configurado para Flexible Sync.
booleanopúblico	isPartitionBasedSyncConfiguration () Retorna se essa configuração é ou não para abrir um Realm configurado para Sincronização baseada em partição.
booleanoprotegido	isSyncConfiguration ()
booleanoprotegido	realmExists () Verifica se o Arquivo de Realm definido por esta configuração já existe.
booleanopúblico	shouldDeleteRealmOnLogout () Retorna `true` se o Arquivo de Realm precisar ser excluído assim que o usuário proprietário dele sair.
booleanopúblico	shouldWaitForInitialRemoteData () Retorna `true` se o Realm todas as alterações conhecidas do servidor remoto antes de ser aberto pela primeira vez.
public String	toString ()

Métodos herdados

Métodos herdados da classe java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize
Métodos herdados da classe io.realm.RealmConfiguration : getRealmDirectory , getRealmFileName , getEncryptionKey , getSchemaVersion , getMigration , shouldDeleteRealmIfMigrationNeeded , getDurability , getSchemaMediator , getInitialDataTransaction , hasAssetFile , getAssetFilePath , getCompactOnLaunchCallback , getRealmObjectClasses , getPath , realmExists , getRxFactory , getFlowFactory , isReadOnly , isRecoveryConfiguration , getMaxNumberOfActiveVersions , isAllowWritesOnUiThread , isAllowQueriesOnUiThread , equals , getInstance , hashCode , createSchemaMediator , toString , isSyncConfiguration , forRecovery

Detalhes do método

defaultConfig

public static SyncConfiguration defaultConfig (

User user,

ObjectId partitionValue

)

Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.

Parâmetros

user - O usuário que será usado para acessar o aplicativo Realm .
partitionValue - O valor da partição que identifica o Realm remoto que será sincronizado.

Devoluções

a configuração padrão para o usuário fornecido e o valor da partição.

public static SyncConfiguration defaultConfig (

User user,

Integer partitionValue

)

Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.

Parâmetros

user - O usuário que será usado para acessar o aplicativo Realm .
partitionValue - O valor da partição que identifica o Realm remoto que será sincronizado.

Devoluções

a configuração padrão para o usuário fornecido e o valor da partição.

public static SyncConfiguration defaultConfig (

User user,

Long partitionValue

)

Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.

Parâmetros

user - O usuário que será usado para acessar o aplicativo Realm .
partitionValue - O valor da partição que identifica o Realm remoto que será sincronizado.

Devoluções

a configuração padrão para o usuário fornecido e o valor da partição.

public static SyncConfiguration defaultConfig (

User user,

String partitionValue

)

Retorna uma configuração padrão de sincronização baseada em partição para o usuário fornecido e o valor da partição.

Parâmetros

user - O usuário que será usado para acessar o aplicativo Realm .
partitionValue - O valor da partição que identifica o Realm remoto que será sincronizado.

Devoluções

a configuração padrão para o usuário fornecido e o valor da partição.

public static SyncConfiguration defaultConfig ( User user )
Retorna uma configuração padrão do Flexible Sync para o usuário fornecido. Parâmetros `user` - O usuário que será usado para acessar o aplicativo Realm . Devoluções a configuração padrão do Flexible Sync para o usuário específico. Veja também: {@link SubscriptionSet} para mais informações sobre Flexible Sync.

é igual a

public boolean equals ( Object o )
Substitui `equals` na classe RealmConfiguration

forRecuperação

public static RealmConfiguration forRecovery (

String canonicalPath

)

Retorna uma RealmConfiguration apropriada para abrir um Realm somente leitura e não sincronizado para recuperar quaisquer alterações pendentes. Isso é útil ao tentar abrir um Realm de backup/recuperação (após a redefinição de um cliente). Observação: isso usará o módulo Realm padrão (composto por todos os RealmModel ) e presumirá que nenhuma criptografia também deve ser usada.

Parâmetros

canonicalPath - o caminho absoluto para o Arquivo de Realm definido por esta configuração.

Devoluções

RealmConfiguration que pode ser usado offline

public static RealmConfiguration forRecovery (

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

)

Parâmetros

canonicalPath - o caminho absoluto para o Arquivo de Realm definido por esta configuração.
encryptionKey - a chave usada para criptografar/descriptografar o Arquivo de Realm.
modules - se especificado, restringirá o esquema de Realm ao módulo fornecido.

Devoluções

RealmConfiguration que pode ser usado offline

getClientResetHandler

public SyncSession.ClientResetHandler getClientResetHandler ()
Retorna o manipulador de redefinição do cliente para este SyncConfiguration. Devoluções o manipulador de redefinição do cliente.

getErrorHandler

public SyncSession.ErrorHandler getErrorHandler ()
Retorna o manipulador de erros para este SyncConfiguration. Devoluções o manipulador de erros.

getInitialDataTransaction

protected Realm.Transaction getInitialDataTransaction ()
Retorna a instância da transação com dados iniciais. Devoluções a transação de dados inicial. Substitui `getInitialDataTransaction` na classe RealmConfiguration

getInitialRemoteDataTimeout

public long getInitialRemoteDataTimeout (

TimeUnit unit

)

Retorna o tempo limite definido ao baixar quaisquer dados iniciais na primeira vez que o Realm for aberto.Esse valor só é aplicável se shouldWaitForInitialRemoteData() trueretornar.

Devoluções

o tempo em que o Realm esperará que todas as alterações sejam baixadas antes de ser abortado e uma exceção ser lançada.

Veja também:

SyncConfiguration.Builder.waitForInitialRemoteData(long, TimeUnit)

getInitialSubscriptionsHandler

public SyncConfiguration.InitialFlexibleSyncSubscriptions getInitialSubscriptionsHandler ()
Retorna o manipulador de assinatura inicial configurado para este Realm. Devoluções o manipulador costumava configurar assinaturas iniciais para esse domínio.

getPartitionValue

public BsonValue getPartitionValue ()

Retorna o valor em que este Realm é particionado. A chave de partição é uma propriedade definida no MongoDB Realm. Todas as classes com uma propriedade com este valor serão sincronizadas com o Realm.

Devoluções

o valor sendo usado pelo MongoDB Realm para dividir o MongoDB database do lado do servidor em Realms que podem ser sincronizados de forma independente.

Lança

IllegalStateException - se essa configuração for para um Realm configurado para Flexible Sync. Você pode usar isPartitionBasedSyncConfiguration() antes de chamar este método para verificar.

getServerUrl

public URI getServerUrl ()
Retorna o URI do servidor para o MongoDB Realm remoto com o qual o Realm local está sincronizando. Devoluções URI identificando o MongoDB Realm com o qual este Realm local está sincronizado.

getSessionStopPolicy

public OsRealmConfig.SyncSessionStopPolicy getSessionStopPolicy ()
OBSERVAÇÃO: apenas para uso interno. Pode mudar sem aviso. Retorna a política de interrupção da sessão para esse Realm assim que o Realm for fechado. Devoluções a política de interrupção usada pela sessão depois que o Realm é fechado.

getSyncClientResetStrategy

public SyncClientResetStrategy getSyncClientResetStrategy ()
Retorna a estratégia de redefinição do cliente de sincronização para este SyncConfiguration. Devoluções a estratégia de reinício do cliente de sincronização.

getUrlPrefix

public String getUrlPrefix ()
Retorna o prefixo da URL usado ao estabelecer uma conexão de sincronização com o servidor de Objeto de Realm.

getUser

public User getUser ()
Retorna o usuário. Devoluções o usuário.

hashCode

public int hashCode ()
Substitui `hashCode` na classe RealmConfiguration

isFlexibleSyncConfiguration

public boolean isFlexibleSyncConfiguration ()
Retorna se essa configuração é ou não para abrir um Realm configurado para Flexible Sync. Devoluções `true` se esta configuração for para um Flexible Sync Realm, `false` caso contrário.

isPartitionBasedSyncConfiguration

public boolean isPartitionBasedSyncConfiguration ()
Retorna se essa configuração é ou não para abrir um Realm configurado para Sincronização baseada em partição. Devoluções `true` se esta configuração for para um Sincronização Realm baseado em Partição, caso contrário, `false` .

isSyncConfiguration

protected boolean isSyncConfiguration ()
Substitui `isSyncConfiguration` na classe RealmConfiguration

realmExists

protected boolean realmExists ()

Verifica se o arquivo Realm definido por esta configuração já existe.AVISO: Esse método é apenas uma verificação pontual. A menos que protegido por sincronização externa, outro thread ou processo pode ter criado ou excluído o arquivo Realm logo após o retorno desse método.

Devoluções

true se o Arquivo de Realm existir, false caso contrário.

Substitui

realmExists na classe RealmConfiguration

shouldDeleteRealmOnLogout

public boolean shouldDeleteRealmOnLogout ()
Retorna `true` se o Arquivo de Realm precisar ser excluído assim que o usuário proprietário dele sair. Devoluções `true` se o Arquivo de Realm precisar ser excluído se o usuário sair. `false` se o arquivo puder ficar para trás.

shouldWaitForInitialRemoteData

public boolean shouldWaitForInitialRemoteData ()
Retorna `true` se o Realm todas as alterações conhecidas do servidor remoto antes de ser aberto pela primeira vez. Devoluções `true` se todas as alterações remotas forem baixadas antes que o Realm possa ser aberto. `false` se o Realm puder ser aberto imediatamente.

toString

public String toString ()
Substitui `toString` na classe RealmConfiguration

Voltar

SyncClientResetStrategy

SyncConfiguration.Builder