/ /

/ /

SDK de Dispositivo Atlas

Java SDK

Referencia de API

io.realm.mongodb

Class AppConfiguration.Builder

Los SDK de dispositivos Atlas están obsoletos. Consulte deprecation page for details.

io.realm.mongodb

java.lang.Object

io.realm.mongodb.AppConfiguration.Builder

Enclosing class:

AppConfiguration

Constructor utilizado para crear instancias de una AppConfiguration de manera fluida.

Constructores

Constructor and Description
Builder ( String appId ) Crea una instancia del Constructor para la AppConfiguration.

Resumen del método

Modificador y Tipo	Método y descripción
AppConfiguration.Builder público	addCustomRequestHeader ( String headerName, String headerValue ) Adds an extra HTTP header to append to every request to a Realm Object Server.
AppConfiguration.Builder público	addCustomRequestHeaders ( java.util.Map<java.lang.String, java.lang.String> headers ) Agrega cabeceras HTTP extra a cada solicitud hacia un objeto Realm servidor.
AppConfiguration.Builder público	appName ( String appName ) Establece el nombre de la aplicación.
AppConfiguration.Builder público	appVersion ( String appVersion ) Sets the apps version.
AppConfiguration.Builder público	authorizationHeaderName ( String headerName ) Establece el nombre del encabezado HTTP utilizado para enviar datos de autorización al realizar solicitudes a MongoDB Realm.
AppConfiguration.Builder público	baseUrl ( String baseUrl ) Establece la URL base para la aplicación MongoDB Realm.
public AppConfiguration	build () Creates the AppConfiguration.
AppConfiguration.Builder público	codecRegistry ( CodecRegistry codecRegistry ) Set the default codec registry used to encode and decode BSON arguments and results when calling remote Realm io.realm.mongodb.functions.Functions and accessing a remote io.realm.mongodb.mongo.MongoDatabase .
AppConfiguration.Builder público	defaultClientResetHandler ( SyncSession.ClientResetHandler handler ) Establece el controlador de restablecimiento de cliente predeterminado que utilizan Synced Realms cuando informan un restablecimiento de cliente.
AppConfiguration.Builder público	defaultSyncClientResetStrategy ( DiscardUnsyncedChangesStrategy strategy ) Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset.
AppConfiguration.Builder público	defaultSyncClientResetStrategy ( ManuallyRecoverUnsyncedChangesStrategy strategy ) Sets the default sync client reset strategy used by Synced Realms when they report a Client Reset.
AppConfiguration.Builder público	defaultSyncErrorHandler ( SyncSession.ErrorHandler errorHandler ) Establece el controlador de errores predeterminado que utiliza Synced Realms al informar errores con su sesión.
AppConfiguration.Builder público	encryptionKey ( byte[] key ) Sets the encryption key used to encrypt user meta data only.
AppConfiguration.Builder público	httpLogObfuscator ( HttpLogObfuscator httpLogObfuscator ) Establece el HttpLogObfuscator utilizado para evitar que la información sensible en las solicitudes HTTP se muestre en el logcat.
AppConfiguration.Builder público	requestTimeout ( long time, TimeUnit unit ) Establece el tiempo de espera por defecto utilizado por las solicitudes de red a la aplicación MongoDB Realm.
AppConfiguration.Builder público	syncRootDirectory ( File rootDir ) Configures the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm.

Inherited Methods

Métodos heredados de la clase java.lang.Object: getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Detalle del constructor

public Builder ( String appId )
Crea una instancia del Constructor para la AppConfiguration. Parámetros `appId` - the application id of the MongoDB Realm Application.

Detalle del método

añadir encabezado de solicitud personalizado

public AppConfiguration.Builder addCustomRequestHeader ( String headerName, String headerValue )
Adds an extra HTTP header to append to every request to a Realm Object Server. Parámetros `headerName` - the name of the header. `headerValue` - el valor del encabezado. Throws IllegalArgumentException - if a non-empty `headerName` is provided or a null `headerValue` .

addCustomRequestHeaders

public AppConfiguration.Builder addCustomRequestHeaders ( java.util.Map<java.lang.String, java.lang.String> headers )
Agrega cabeceras HTTP extra a cada solicitud hacia un objeto Realm servidor. Parámetros `headers` - mapa de pares (headerName, headerValue). Throws IllegalArgumentException - If any of the headers provided are illegal.

appName

public AppConfiguration.Builder appName ( String appName )
Sets the apps name. This is only used as part of debug headers sent when making network requests at the MongoDB Realm application. Parámetros `appName` - app name used to identify the application.

appVersion

public AppConfiguration.Builder appVersion ( String appVersion )
Sets the apps version. This is only used as part of debug headers sent when making network requests at the MongoDB Realm application. Parámetros `appVersion` - app version used to identify the application.

nombreDeEncabezadoDeAutorización

public AppConfiguration.Builder authorizationHeaderName (

String headerName

)

Establece el nombre del encabezado HTTP utilizado para enviar datos de autorización al realizar solicitudes a MongoDB Realm. El servidor MongoDB o el firewall se debe haber configurado para esperar un encabezado de autorización personalizado.El encabezado de autorización por defecto se llama DEFAULT_AUTHORIZATION_HEADER_NAME.

Parámetros

headerName - nombre del encabezado.

Throws

IllegalArgumentException - if a null or empty header is provided.

baseUrl

public AppConfiguration.Builder baseUrl ( String baseUrl )
Establece la URL base para la aplicación MongoDB Realm. El valor predeterminado es DEFAULT_BASE_URL. Parámetros `baseUrl` - la URL base para la aplicación MongoDB Realm.

compilar

public AppConfiguration build ()
Creates the AppConfiguration. Devuelve la AppConfiguration que se puede utilizar para crear una aplicación.

codecRegistry

public AppConfiguration.Builder codecRegistry (

CodecRegistry codecRegistry

)

Set the default codec registry used to encode and decode BSON arguments and results when calling remote Realm io.realm.mongodb.functions.Functions and accessing a remote io.realm.mongodb.mongo.MongoDatabase .

El valor predeterminado será DEFAULT_BSON_CODEC_REGISTRY si no se especifica.

Parámetros

codecRegistry - The default codec registry for the App.

Tip

DEFAULT_BSON_CODEC_REGISTRY
Constructor.getDefaultCodecRegistry()

defaultClientResetHandler

public AppConfiguration.Builder defaultClientResetHandler ( SyncSession.ClientResetHandler handler )
Sets the default Client Reset handler used by Synced Realms when they report a Client Reset. session.This default can be overridden by calling io.realm.mongodb.sync.SyncConfiguration.Builder.clientResetHandler(SyncSession.ClientResetHandler) when creating the io.realm.mongodb.sync.SyncConfiguration . Parámetros `handler` - the default Client Reset handler.

defaultSyncClientResetStrategy

public AppConfiguration.Builder defaultSyncClientResetStrategy (

DiscardUnsyncedChangesStrategy strategy

)

Establece la estrategia de restablecimiento del cliente de sincronización predeterminada utilizada por Synced Realms cuando informan un restablecimiento del cliente. Esta sesión predeterminada se puede anular llamando a io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(ManuallyRecoverUnsyncedChangesStrategy) o io.realm.mongodb.sync.SyncConfiguration.Builder.syncClientResetStrategy(DiscardUnsyncedChangesStrategy) al crear io.realm.mongodb.sync.SyncConfiguration.

Parámetros

strategy - the default sync client reset strategy.

public AppConfiguration.Builder defaultSyncClientResetStrategy (

ManuallyRecoverUnsyncedChangesStrategy strategy

)

Parámetros

strategy - the default sync client reset strategy.

defaultSyncErrorHandler

public AppConfiguration.Builder defaultSyncErrorHandler ( SyncSession.ErrorHandler errorHandler )
Sets the default error handler used by Synced Realms when reporting errors with their session.This default can be overridden by calling io.realm.mongodb.sync.SyncConfiguration.Builder.errorHandler(SyncSession.ErrorHandler) when creating the io.realm.mongodb.sync.SyncConfiguration . Parámetros `errorHandler` - the default error handler.

encryptionKey

public AppConfiguration.Builder encryptionKey ( byte[] key )
Sets the encryption key used to encrypt user meta data only. Individual Realms needs to use io.realm.mongodb.sync.SyncConfiguration.Builder.encryptionKey(byte[]) to make them encrypted. Parámetros `key` - una clave de cifrado de 64 bytes. Throws IllegalArgumentException - if the key is not 64 bytes long.

httpLogObfuscator

public AppConfiguration.Builder httpLogObfuscator ( HttpLogObfuscator httpLogObfuscator )
Establece el HttpLogObfuscator utilizado para evitar que la información sensible en las solicitudes HTTP se muestre en el logcat. Si no se especifica, se ofuscarán las solicitudes de inicio de sesión HTTP por defecto. Parámetros `httpLogObfuscator` - el ofuscador de registro HTTP predeterminado para la aplicación.

requestTimeout

public AppConfiguration.Builder requestTimeout ( long time, TimeUnit unit )
Sets the default timeout used by network requests against the MongoDB Realm application. Requests will terminate with a failure if they exceed this limit. The default value is AppConfiguration.DEFAULT_REQUEST_TIMEOUT seconds. Parámetros `time` - the timeout value for network requests. `unit` - la unidad de tiempo utilizada para definir el tiempo de espera.

syncRootDirectory

public AppConfiguration.Builder syncRootDirectory ( File rootDir )
Configura la carpeta raíz que contiene todos los archivos y reinos utilizados al sincronizar datos entre el dispositivo y MongoDB Realm. El directorio raíz predeterminado es `Context.getFilesDir()/mongodb-realm` . Parámetros `rootDir` - dónde almacenar los archivos relacionados con la sincronización.

Volver

AppConfiguration

Escucha de autenticación