Menu Docs

Página inicial do DocsDesenvolver aplicaçõesAtlas Device SDKs

Class RealmConfiguration

Nesta página

  • io.realm
  • Resumo da classe aninhada
  • Resumo do campo
  • Resumo do método
  • Métodos herdados
  • Detalhes do campo
  • DEFAULT_REALM_NAME
  • Detalhes do método
  • createSchemaMediator
  • é igual a
  • forRecuperação
  • getAssetFilePath
  • getCompactOnLaunchCallback
  • getDuribility
  • getEncryptionKey
  • getFlowFactory
  • getInitialDataTransaction
  • getInstance
  • getMaxNumberOfAtiveVersions
  • getMigration
  • getPath
  • getRealmDirectory
  • getRealmFileName
  • getRealmObjectClasses
  • getRxFactory
  • getSchemaMediator
  • getSchemaVersion
  • hasAssetFile
  • hashCode
  • isAllowQueriesOnUiThread
  • isAllowWritesOnUiThread
  • isReadOnly
  • isRecuperaçãoConfiguração
  • isSyncConfiguration
  • realmExists
  • shouldDeleteRealm IfMigrationNeeded
  • toString
io.realm.RealmConfiguration

Um RealmConfiguration é usado para configurar uma instância de Realm específica.As instâncias de um RealmConfiguration só podem ser criadas usando o io.realm.RealmConfiguration.Builder e chamando seu io.realm.RealmConfiguration.Builder.build() método.

Uma RealmConfiguration comumente usada pode ser facilmente acessada salvando-a primeiro como Realm.setDefaultConfiguration(RealmConfiguration) e, em seguida, usando io.realm.Realm.getDefaultInstance() .

Uma configuração mínima pode ser criada usando:

RealmConfiguration config = new RealmConfiguration.Builder().build()

Isso criará um RealmConfiguration com as seguintes propriedades.

  • Arquivo de Realm é chamado de "default.realm"

  • Ele é salvo em Context.getFilesDir()

  • Ela tem sua versão do esquema definida como 0.

Modificador e tipo
Classe e descrição
public static
Modificador e tipo
campo e descrição
stringfinal pública estática
Modificador e tipo
Método e descrição
RealmProxyMediatorestático protegido
booleanopúblico
Objeto obj
)
RealmConfigurationestático protegido
Corda canonicalPath,
byte[] encryptionKey,
RealmProxyMediator schemaMediator
)

Retorna o caminho para o arquivo de ativo do Realm.

Retorna um chamada de resposta para determinar se o Arquivo de Realm deve ser compactado antes de ser devolvido ao usuário.

public OsRealmConfig.Duribility
bytepúblico

Retorna a FlowFactory que é usada para criar Kotlin Flows a partir de Objeto de Realm.

Retorna a instância da transação com dados iniciais.

Realm protegido
Versão de OsSharedRealm.VersionID
)
público longo
migração pública do Realm

Retorna o caminho absoluto para onde o Arquivo de Realm será salvo.

conjunto público

Retorna o conjunto não modificável de classes de modelo que compõem o esquema para este Realm.

Retorna o RxObservableFactory que é usado para criar Rx Observables a partir de Objeto de Realm.

RealmProxyMediatorprotegido

Retorna a instância do mediador do esquema que é definida por esta configuração.

público longo
booleanopúblico

Indica se um arquivo de ativo foi configurado para esta configuração.

public int
booleanopúblico

Retorna se um RealmQuery pode ser iniciado a partir do thread da interface do usuário.

booleanopúblico

Retorna se as chamadas para Realm.executeTransaction podem ser feitas no thread da UI.

booleanopúblico

Retorna se este Realm é somente leitura ou não.

booleanopúblico
booleanoprotegido
booleanoprotegido

Verifica se o Arquivo de Realm definido por esta configuração já existe.

booleanopúblico
  • Métodos herdados da classe java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

RealmProxyMediator estático protegido createSchemaMediator (
)
boolean público igual a (
Objeto obj
)

Substitui

equals no objeto de classe

RealmConfiguration forRecovery estático protegido (
Corda canonicalPath,
byte[] encryptionKey,
RealmProxyMediator schemaMediator
)

Retorna o caminho para o arquivo de ativo do Realm.

Devoluções

caminho para o arquivo de ativo relativo ao diretório de ativo ou null se nenhum arquivo de ativo foi especificado.

Retorna um chamada de resposta para determinar se o Arquivo de Realm deve ser compactado antes de ser devolvido ao usuário.

Devoluções

uma chamada de resposta chamada 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 o total de bytes usados pelos dados no arquivo.

public OsRealmConfig.Durability getDurability ()

byte público getEncryptionKey ()

Retorna a FlowFactory que é usada para criar Kotlin Flows a partir de Objeto de Realm.

Devoluções

a instância de fábrica usada para criar Fluxos.

Lança

Retorna a instância da transação com dados iniciais.

Devoluções

a transação de dados inicial.

getInstance de Realm protegido (
Versão de OsSharedRealm.VersionID
)

Devoluções

o número máximo de versões ativas permitidas antes que uma exceção seja lançada.

Retorna o caminho absoluto para onde o Arquivo de Realm será salvo.

Devoluções

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

Retorna o conjunto não modificável de classes de modelo que compõem o esquema para este Realm.

Devoluções

conjunto não modificável de classes de modelo.

Retorna o RxObservableFactory que é usado para criar Rx Observables a partir de Objeto de Realm.

Devoluções

a instância de fábrica usada para criar Rx Observables.

Lança

RealmProxyMediator getSchemaMediator protegido ()

Retorna a instância do mediador do esquema que é definida por esta configuração.

Devoluções

o mediador do esquema.

getSchemaVersion público longo ()

hasAssetFile booleano público ()

Indica se um arquivo de ativo foi configurado para esta configuração.

Devoluções

true se houver um arquivo de ativo, caso contrário, false .

hashCode int público()

Substitui

hashCode no objeto de classe

boolean público isAllowQueriesOnUiThread ()

Retorna se um RealmQuery pode ser iniciado a partir do thread da interface do usuário.

Por padrão, o Realm permite query na thread principal. Para proibir isso, os usuários precisam aceitar explicitamente Builder.allowQueriesOnUiThread(boolean) ou seu equivalente do construtor Realm Sync.

Devoluções

se as queries podem ou não ser executadas a partir do thread da UI.

boolean público isAllowWritesOnUiThread ()

Retorna se as chamadas para Realm.executeTransaction podem ser feitas no thread da UI.

Observação: o Realm não permite que transações de bloqueio sejam executadas no thread principal, a menos que os usuários aceitem explicitamente Builder.allowWritesOnUiThread(boolean) ou sua contraparte do construtor Realm Sync.

Devoluções

se as operações de gravação podem ou não ser executadas a partir do thread de UI.

boolean público isReadOnly ()

Retorna se este realm é somente leitura ou não. Os domínios somente leitura não podem ser modificados e lançarão uma IllegalStateException se Realm.beginTransaction() for chamado nele.

Devoluções

true se este Realm for somente leitura, false caso contrário.

boolean público isRecoveryConfiguration ()

Devoluções

true se essa configuração for destinada a abrir um Realm (como resultado de um reinício do cliente).

Dica

Veja também:

  • {@link ClientResetRequiredError}

boolean isSyncConfiguration () protegido

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

← Interface RealmCollection