Classe SyncConfiguration.Builder

Adiciona um módulo aos módulos já definidos.

Define se RealmQueries é permitido ou não a partir do thread da interface do usuário.

Por padrão, o Realm permite queries na thread principal. No entanto, ao fazer isso, seu aplicativo pode sofrer uma queda de armações ou até mesmo ANRs. Recomendamos direcionar as consultas para threads que não sejam da interface do usuário ou, alternativamente, usar RealmQuery.findAllAsync() ou RealmQuery.findFirstAsync() .

Define se as chamadas para Realm.executeTransaction são permitidas ou não a partir do thread da UI.

AVISO: o Realm não permite que transações síncronas sejam executadas na thread principal, a menos que os usuários optem explicitamente por esse método. Recomendamos redirecionar chamadas para executeTransaction para threads que não sejam da interface do usuário ou, alternativamente, usar Realm.executeTransactionAsync .

Ao abrir o Realm pela primeira vez, em vez de criar um arquivo vazio, o arquivo Realm será copiado do arquivo de ativos fornecido e usado no lugar. Isso pode ser usado para preencher previamente o Realm com dados, para que ele não tenha a ser baixado do servidor.

O arquivo Realm fornecido deve ser um Realm sincronizado válido para o usuário fornecido e deve ter sido criado usando o Realm.writeCopyTo(File) API.

AVISO: essa pode ser uma operação demorada e, de preferência, deve ser feita em um thread em segundo plano.

Parâmetros

• assetFile - caminho para o arquivo de banco de dados de dados do ativo.

Lança

• IllegalStateException - if this Realm is also marked as inMemory() .

Cria o RealmConfiguration com base nos parâmetros do construtor.

Devoluções

o SyncConfiguration criado.

Lança

• Exceção de estado ilegal - se os parâmetros de configuração forem inválidos ou inconsistentes.

Define o manipulador para quando ocorre um reinício do cliente. Se nenhum manipulador estiver definido, e o erro for registrado quando ocorrer um reinício do cliente.

Parâmetros

• handler - manipulador personalizado no caso de uma redefinição de cliente.

Define isso para determinar se o Arquivo de Realm deve ser compactado antes de retornar ao usuário. É passado o tamanho total do arquivo (dados + espaço livre) e os bytes usados pelos dados no arquivo.

Parâmetros

• compactOnLaunch - um chamada de resposta de chamada chamado ao abrir um Realm pela primeira vez durante a vida útil de um processo para determinar se ele deve ser compactado antes de ser retornado ao usuário. É passado o tamanho total do arquivo (dados + espaço livre) e os bytes usados pelos dados no arquivo.

Definir isso fará com que o Realm compactará o Arquivo de Realm se o Arquivo de Realm ficar muito grande e uma quantidade significativa de espaço puder ser recuperada. Consulte DefaultCompactOnLaunchCallback para obter detalhes.

Define a chave de bytes io.realm.Realm#ENCRYPTION_KEY_LENGTH usada para criptografar e descriptografar o arquivo Realm.

Parâmetros

• key - a chave de criptografia.

Lança

• IllegalArgumentException - se a chave for inválida.

Define o manipulador de erros utilizado por esta configuração.Somente erros não manipulados pelo SyncPolicy definido serão relatados a este manipulador de erros.

Parâmetros

• errorHandler - manipulador de erros usado para relatar erros ao se comunicar com o Realm Object Server.

Lança

• IllegalArgumentException - null se for fornecido como um manipulador de erro.

Define o FlowFactory usado para criar fluxos de corrotina a partir de Objeto de Realm. O padrão de fábrica é o RealmFlowFactory .

Parâmetros

• factory - de fábrica para usar.

Definir isso criará um Realm na memória em vez de salvá-lo no disco. Os Realms na memória ainda podem usar espaço em disco se a memória estiver fraca, mas todos os arquivos criados por um Realm na memória serão excluídos quando o Realm for fechado.Observe que, como os Realms na memória não são persistentes, você deve ter certeza de mantenha pelo menos uma referência não fechada ao objeto de Realm na memória com o nome específico, enquanto quiser que os dados durem.

Define os dados iniciais em io.realm.Realm . Esta transação será executada somente na primeira vez que o arquivo Realm for aberto (criado) ou durante a migração dos dados se RealmConfiguration.Builder.deleteRealmIfMigrationNeeded() estiver definido.

Parâmetros

• transaction - transação a ser executada.

Sets the initial inscrição s for the io.realm.Realm . This will only be executed the first time the Realm file is opened (and the file created). If waitForInitialRemoteData() is configured as well, the realm file isn't fully opened until all subscription data also has been uploaded.

Parâmetros

• action - MutableSubscriptionDefinir onde as assinaturas podem ser adicionadas.

Define o número máximo de versões ativas no arquivo Realm antes de uma IllegalStateException é lançado ao tentar gravar mais dados.

O Realm é capaz de lidar simultaneamente com muitas versões diferentes de Objeto de Realm. Isso pode acontecer se você tiver um Realm aberto em muitos threads diferentes ou estiver congelando objetos enquanto os dados estão sendo gravados no arquivo.

Em circunstâncias normais, isso não é um problema, mas se o número de versões ativas aumentar demais, isso terá um efeito negativo no tamanho do arquivo no disco. A definição desses parâmetros pode, portanto, ser usada para evitar usos do Realm que podem resultar em Realms muito grandes.

Observe que o número da versão também aumentará quando alterações de outros dispositivos forem integradas neste dispositivo, portanto, o número de versões ativas também dependerá do que os outros dispositivos que gravam no mesmo Realm estão fazendo.

Parâmetros

• number - o número máximo de versões ativas antes de uma exceção ser lançada.

Substitui o(s) módulo(s) existente(s) por um ou mais RealmModule s. A utilização deste método substituirá o esquema atual deste Realm pelo esquema definido pelos módulos fornecidos.

Uma referência ao módulo Realm padrão contendo todas as classes Realm no projeto (mas não dependências), pode ser encontrada utilizando Realm.getDefaultModule() . A combinação do esquema do projeto do aplicativo e de uma dependência da biblioteca é feita com o seguinte código:

builder.modules(Realm.getDefaultMode(), new MyLibraryModule());

Parâmetros

• modules - lista de módulos do primeiro módulo Realm (obrigatório).

Lança

• IllegalArgumentException - se algum dos módulos não tiver a anotação RealmModule .

Substitui o(s) módulo(s) existente(s) por um ou mais RealmModule s. A utilização deste método substituirá o esquema atual deste Realm pelo esquema definido pelos módulos fornecidos.

Uma referência ao módulo Realm padrão contendo todas as classes Realm no projeto (mas não dependências), pode ser encontrada utilizando Realm.getDefaultModule() . A combinação do esquema do projeto do aplicativo e de uma dependência da biblioteca é feita com o seguinte código:

builder.modules(Realm.getDefaultMode(), new MyLibraryModule());

Parâmetros

• baseModule - o primeiro módulo Realm (obrigatório).

• additionalModules - os módulos adicionais do Realm

Lança

• IllegalArgumentException - se algum dos módulos não tiver a anotação RealmModule .

Define o nome do Arquivo de Realm neste dispositivo.

Parâmetros

• filename - nome do Arquivo de Realm.

Definir isso fará com que o Realm se torne somente leitura e todas as transações de gravação feitas nesse Realm falharão com uma IllegalStateException .

Isso em particular média que initialData(Realm.Transaction) não funcionará em combinação com um Realm somente leitura e definir isso resultará no lançamento de uma IllegalStateException.

Marcar um Realm como somente leitura se aplica apenas ao Realm nesse processo. Outros processos e dispositivos ainda podem escrever no Realm.

Define o RxObservableFactory usado para criar Rx Observables a partir de Objeto de Realm. O padrão de fábrica é RealmObservableFactory .

Parâmetros

• factory - de fábrica para usar.

Define a versão do esquema do Realm.Synced Realms suportam apenas alterações de esquema aditivas que podem ser aplicadas sem exigir uma migração manual. A versão do esquema será usada somente como uma indicação para a camada de armazenamento subjacente remover ou adicionar índices. Eles serão recalculados se a versão do esquema fornecida for diferente da versão no arquivo Realm. AVISO: não há garantias de que o valor inserido aqui seja o mesmo retornado por Realm.getVersion(). Devido à natureza dos Realms sincronizados, o valor pode ser maior e menor.

• Ele será mais baixo se outro cliente com um schemaVersion menor se conectar ao servidor pela primeira vez depois que essa schemaVersion tiver sido usada.

• Seria maior se outro cliente com um schemaVersion superior conectado ao servidor após este Realm ter sido criado.

Parâmetros

• schemaVersion - a versão do esquema.

Lança

• IllegalArgumentException - se a versão do esquema for inválida.

Sets the handler for when a Client Reset occurs. If no handler is set, and error is logged when a Client Reset occurs. This strategy is only available for synced realms using partition based sync. Realms using flexible sync currently only support syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) .

Parâmetros

• handler - manipulador de perda contínua personalizado no caso de uma redefinição de cliente.

Define o manipulador para quando ocorre um reinício do cliente. Se nenhum manipulador estiver definido, e o erro for registrado quando ocorrer um reinício do cliente.

Parâmetros

• handler - manipulador manual personalizado no caso de uma redefinição de cliente.

O prefixo que é anexado ao caminho na solicitação do WebSocket que inicia uma conexão de sincronização com o MongoDB Realm. O valor especificado deve corresponder à configuração do servidor, caso contrário, o dispositivo não poderá criar uma conexão. Esse valor é opcional e só deve ser definido se uma regra de firewall específica exigir isso.

Parâmetros

• urlPrefix - O prefixo a ser anexado ao URL de conexão de sincronização.

Configurar isso fará com que o Realm baixe todas as alterações conhecidas do servidor na primeira vez que um Realm for aberto. O Realm não será aberto até que todos os dados tenham sido baixados. Isso significa que, se um dispositivo estiver off-line, o Realm não será aberto.Como o download de todas as alterações pode ser uma operação demorada que pode bloquear o thread da interface do usuário, os Realms com essa configuração ativada só devem ser abertos em threads em segundo plano ou com Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) no thread da interface do usuário.

Esta verificação só é imposta na primeira vez que um Realm é criado. Se, de outra forma, você quiser garantir que um Realm tenha as alterações mais recentes, use SyncSession.downloadAllServerChanges() .

Parâmetros

• timeout - quanto tempo esperar para que o download seja concluído antes de um io. Realm.Exceptions.DownloadingRealmInterruptedException é lançada.

• unit - a unidade de tempo usada para definir o tempo limite.

Configurar isso fará com que o Realm baixe todas as alterações conhecidas do servidor na primeira vez que um Realm for aberto. O Realm não será aberto até que todos os dados tenham sido baixados. Isso significa que, se um dispositivo estiver off-line, o Realm não será aberto.Como o download de todas as alterações pode ser uma operação demorada que pode bloquear o thread da interface do usuário, os Realms com essa configuração ativada só devem ser abertos em threads em segundo plano ou com Realm.getInstanceAsync(RealmConfiguration, Realm.Callback) no thread da interface do usuário.

Esta verificação só é imposta na primeira vez que um Realm é criado. Se, de outra forma, você quiser garantir que um Realm tenha as alterações mais recentes, use SyncSession.downloadAllServerChanges() .