Pacote io.realm.mongodb

Classe AppConfiguration.Builder

java.lang.Object

io.realm.mongodb.AppConfiguration.Builder

Classe anexa:

AppConfiguration

public static class AppConfiguration.Builder
extends Object

O construtor usado para construir instâncias de um AppConfiguration de forma fluente.

Resumo do construtor

Construtores

Constructor	Descrição
Builder(String appId)	Cria uma instância do Construtor para a AppConfiguration.

Resumo do método

Modificador e tipo	Método	Descrição
AppConfiguration.Builder	addCustomRequestHeader(String headerName, String headerValue)	Adiciona um cabeçalho HTTP extra para anexar a cada solicitação a um servidor de objetos de Realm.
AppConfiguration.Builder	addCustomRequestHeaders(Map<String,String> headers)	Adiciona cabeçalhos HTTP extras para anexar a cada solicitação a um servidor de objetos de Realm.
AppConfiguration.Builder	appName(String appName)	Define o nome do aplicativo.
AppConfiguration.Builder	appVersion(String appVersion)	Define a versão dos aplicativos.
AppConfiguration.Builder	authorizationHeaderName(String headerName)	Define o nome do cabeçalho HTTP usado para enviar dados de autorização ao fazer solicitações ao MongoDB Realm.
AppConfiguration.Builder	baseUrl(String baseUrl)	Define a URL base para o aplicativo MongoDB Realm.
AppConfiguration	build()	Cria a AppConfiguration.
AppConfiguration.Builder	codecRegistry(CodecRegistry codecRegistry)	Defina o registro de codec padrão usado para codificar e decodificar argumentos e resultados BSON ao chamar Realm remoto Functions e acessar um MongoDatabase remoto.
AppConfiguration.Builder	defaultClientResetHandler(SyncSession.ClientResetHandler handler)	Obsoleto. substituído por defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)
AppConfiguration.Builder	defaultSyncClientResetStrategy(DiscardUnsyncedChangesStrategy strategy)	Define a estratégia de reinício do cliente de sincronização padrão usada pelos Realms sincronizados quando relatam um reinício do cliente.
AppConfiguration.Builder	defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy strategy)	Define a estratégia de reinício do cliente de sincronização padrão usada pelos Realms sincronizados quando relatam um reinício do cliente.
AppConfiguration.Builder	defaultSyncErrorHandler(SyncSession.ErrorHandler errorHandler)	Define o manipulador de erros padrão usado pelos Realms Sincronizados ao relatar erros com sua sessão.
AppConfiguration.Builder	encryptionKey(byte[] key)	Define a chave de criptografia usada para criptografar somente os metadados do usuário.
AppConfiguration.Builder	httpLogObfuscator(HttpLogObfuscator httpLogObfuscator)	Define o HttpLogObfuscator usado para impedir que informações confidenciais em solicitações HTTP sejam exibidas no logcat.
AppConfiguration.Builder	requestTimeout(long time, TimeUnit unit)	Define o tempo limite padrão usado pelas solicitações de rede em relação ao aplicativo MongoDB Realm.
AppConfiguration.Builder	syncRootDirectory(File rootDir)	Configura a pasta raiz contendo todos os arquivos e Realms usados ao sincronizar dados entre o dispositivo e o MongoDB Realm.

Métodos herdados da classe java.lang.objeto

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Detalhes do construtor

Construtor

construtor público (string appId)

Cria uma instância do Construtor para a AppConfiguration.

Parâmetros:

appId - o ID do aplicativo MongoDB Realm.

Detalhes do método

encryptionKey

Public AppConfiguration.Builder encryptionKey(chave @ParametersAreNonnullByDefault
                                              byte[])

Define a chave de criptografia usada para criptografar somente os metadados do usuário. Os Realms individuais precisam usar SyncConfiguration.Builder.encryptionKey(byte[]) para torná-los criptografados.

Parâmetros:

key - uma chave de criptografia de 64 bytes.

Lançamentos:

IllegalArgumentException - se a chave não tiver 64 bytes de comprimento.

URL base

public AppConfiguration.Builder baseUrl(String baseUrl)

Define a URL base para o aplicativo MongoDB Realm. O valor padrão é AppConfiguration.DEFAULT_BASE_URL.

Parâmetros:

baseUrl - a URL base do aplicativo MongoDB Realm.

appName

public AppConfiguration.Builder appName (String appName)

Define o nome do aplicativo. Isso só é usado como parte dos cabeçalhos de depuração enviados ao fazer solicitações de rede no aplicativo MongoDB Realm.

Parâmetros:

appName - nome do aplicativo usado para identificar o aplicativo.

versão da aplicação

public AppConfiguration.Builder appVersion(String appVersion)

Define a versão dos aplicativos. Isso só é usado como parte dos cabeçalhos de depuração enviados ao fazer solicitações de rede no aplicativo MongoDB Realm.

Parâmetros:

appVersion - versão do aplicativo usada para identificar o aplicativo.

requestTimeout

public AppConfiguration.Builder requestTimeout(longo tempo, unidade TimeUnit )

Define o tempo limite padrão usado pelas solicitações de rede em relação ao aplicativo MongoDB Realm. As solicitações serão encerradas com uma falha se excederem esse limite. O valor padrão é AppConfiguration.DEFAULT_REQUEST_TIMEOUT segundos.

Parâmetros:

time - o valor de tempo limite para solicitações de rede.

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

authorizedHeaderName

public AppConfiguration.Builder authorizedHeaderName (String headerName)

Define o nome do cabeçalho HTTP usado para enviar dados de autorização ao fazer solicitações ao MongoDB Realm. O MongoDB Server ou firewall deve ter sido configurado para esperar um cabeçalho de autorização personalizado.

O cabeçalho de autorização padrão é denominado AppConfiguration.DEFAULT_AUTHORIZATION_HEADER_NAME.

Parâmetros:

headerName - nome do cabeçalho.

Lançamentos:

IllegalArgumentException - se um cabeçalho nulo ou vazio for fornecido.

addCustomRequestHeader

public AppConfiguration.Builder addCustomRequestHeader(String headerName,
                                                       String headerValue)

Adiciona um cabeçalho HTTP extra para anexar a cada solicitação a um servidor de objetos de Realm.

Parâmetros:

headerName - o nome do cabeçalho.

headerValue - o valor do cabeçalho.

Lançamentos:

IllegalArgumentException - se um headerName não vazio for fornecido ou um headerValue nulo.

addCustomRequestHeaders

public AppConfiguration.Builder addCustomRequestHeaders(@Nullable
                                                        Map<String,String> headers)

Adiciona cabeçalhos HTTP extras para anexar a cada solicitação a um servidor de objetos de Realm.

Parâmetros:

headers - mapa de pares (headerName, headerValue).

Lançamentos:

IllegalArgumentException - Se algum dos cabeçalhos fornecidos for ilegal.

defaultSyncErrorHandler

public AppConfiguration.Builder defaultSyncErrorHandler(SyncSession.ErrorHandler errorHandler)

Define o manipulador de erros padrão usado pelos Realms Sincronizados ao relatar erros com sua sessão.

Esse padrão pode ser substituído chamando SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler) ao criar o SyncConfiguration.

Parâmetros:

errorHandler - o manipulador de erros padrão.

defaultClientResetHandler

@Deprecated
public AppConfiguration.Builder defaultClientResetHandler (manipulador SyncSession.ClientResetHandler )

Obsoleto.

substituído por defaultSyncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy)

Define o manipulador padrão de reinício do cliente usado pelos Realms sincronizados quando relatam um reinício do cliente. sessão.

Esse padrão pode ser substituído chamando SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler) ao criar o SyncConfiguration.

Parâmetros:

handler - o manipulador padrão de reinício do cliente.

defaultSyncClientResetStrategy

public AppConfiguration.Builder defaultSyncClientResetStrategy (@Nonnull
                                                               ManuallyRecuperUnsyncedChangesStrategy strategies)

Define a estratégia de reinício do cliente de sincronização padrão usada pelos Realms sincronizados quando relatam um reinício do cliente. sessão.

Esse padrão pode ser substituído chamando SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ou SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) ao criar o SyncConfiguration.

Parâmetros:

strategy - a estratégia de reinício do cliente de sincronização padrão.

defaultSyncClientResetStrategy

public AppConfiguration.Builder defaultSyncClientResetStrategy (@Nonnull
                                                               DiscardUnsyncedChangesStrategy strategies )

Define a estratégia de reinício do cliente de sincronização padrão usada pelos Realms sincronizados quando relatam um reinício do cliente. sessão.

Esse padrão pode ser substituído chamando SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) ou SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) ao criar o SyncConfiguration.

Parâmetros:

strategy - a estratégia de reinício do cliente de sincronização padrão.

syncRootDirectory

public AppConfiguration.Builder syncRootDirectory(Arquivo rootDir)

Configura a pasta raiz contendo todos os arquivos e Realms usados ao sincronizar dados entre o dispositivo e o MongoDB Realm.

O diretório raiz padrão é Context.getFilesDir()/mongodb-realm.

Parâmetros:

rootDir - onde armazenar arquivos relacionados à sincronização.

CodecRegistry

public AppConfiguration.Builder codecRegistry(CodecRegistry codecRegistry)

Defina o registro de codec padrão usado para codificar e decodificar argumentos e resultados BSON ao chamar Realm remoto Functions e acessar um MongoDatabase remoto.

O padrão será AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY se não for especificado.

Parâmetros:

codecRegistry - O registro de codec padrão para o aplicativo.

Veja também:

AppConfiguration.DEFAULT_BSON_CODEC_REGISTRY, AppConfiguration.getDefaultCodecRegistry()

httpLogObfuscator

public AppConfiguration.Builder httpLogObfuscator(@Nullable
                                                  HttpLogObfuscator httpLogObfuscator)

Define o HttpLogObfuscator usado para impedir que informações confidenciais em solicitações HTTP sejam exibidas no logcat.

Se não for especificado, o padrão será ofuscar as solicitações de login HTTP.

Parâmetros:

httpLogObfuscator - o ofuscador de registro HTTP padrão para o aplicativo.

COMPILAR

public AppConfiguration build()

Cria a AppConfiguration.

Retorna:

a AppConfiguration que pode ser usada para criar um App.