AppConfiguration (Realm 10.0.0)

java.lang.Object
- io.realm.mongodb.AppConfiguration

```
public class AppConfiguration
extends Object
```
A AppConfiguration is used to setup a MongoDB Realm application.
Instances of a AppConfiguration can only created by using the AppConfiguration.Builder and calling its AppConfiguration.Builder.build() method.
Configuring a App is only required if the default settings are not enough. Otherwise calling new App("app-id") is sufficient.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AppConfiguration.Builder
Builder used to construct instances of a AppConfiguration in a fluent manner.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AppConfiguration.Builder` Builder used to construct instances of a `AppConfiguration` in a fluent manner.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_AUTHORIZATION_HEADER_NAME` The default header name used to carry authorization data when making network requests towards MongoDB Realm.
`static String`	`DEFAULT_BASE_URL` The default url for MongoDB Realm applications.
`static CodecRegistry`	`DEFAULT_BSON_CODEC_REGISTRY` Default BSON codec registry for encoding/decoding arguments and results to/from MongoDB Realm backend.
`static long`	`DEFAULT_REQUEST_TIMEOUT` The default request timeout for network requests towards MongoDB Realm in seconds.
`static Map<String,RegexPatternObfuscator>`	`loginObfuscators` Default obfuscators for login requests used in a MongoDB Realm app.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAppId()` Returns the unique app id that identities the Realm application.
`String`	`getAppName()` Returns the name used to describe the Realm application.
`String`	`getAppVersion()` Returns the version of this Realm application.
`String`	`getAuthorizationHeaderName()` Returns the name of the header used to carry authentication data when making network requests towards MongoDB Realm.
`URL`	`getBaseUrl()` Returns the base url for this Realm application.
`Map<String,String>`	`getCustomRequestHeaders()` Returns any custom configured headers that will be sent alongside other headers when making network requests towards MongoDB Realm.
`SyncSession.ClientResetHandler`	`getDefaultClientResetHandler()` Returns the default Client Reset handler used by synced Realms if there are problems with their `SyncSession`.
`CodecRegistry`	`getDefaultCodecRegistry()` Returns the default codec registry used to encode and decode BSON arguments and results when calling remote Realm `Functions` and accessing a remote `MongoDatabase`.
`SyncSession.ErrorHandler`	`getDefaultErrorHandler()` Returns the default error handler used by synced Realms if there are problems with their `SyncSession`.
`byte[]`	`getEncryptionKey()` Returns the encryption key, if any, that is used to encrypt Realm users meta data on this device.
`HttpLogObfuscator`	`getHttpLogObfuscator()` Returns the `HttpLogObfuscator` used in the app, which keeps sensitive information in HTTP requests from being displayed in the logcat.
`long`	`getRequestTimeoutMs()` Returns the default timeout for network requests against the Realm application in milliseconds.
`File`	`getSyncRootDirectory()` Returns the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_BASE_URL
```
public static final String DEFAULT_BASE_URL
```
    The default url for MongoDB Realm applications.
    
    See Also:
    
    AppConfiguration.Builder.baseUrl(String), Constant Field Values
  - DEFAULT_REQUEST_TIMEOUT
```
public static final long DEFAULT_REQUEST_TIMEOUT
```
    The default request timeout for network requests towards MongoDB Realm in seconds.
    
    See Also:
    
    AppConfiguration.Builder.requestTimeout(long, TimeUnit), Constant Field Values
  - DEFAULT_AUTHORIZATION_HEADER_NAME
```
public static final String DEFAULT_AUTHORIZATION_HEADER_NAME
```
    The default header name used to carry authorization data when making network requests towards MongoDB Realm.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BSON_CODEC_REGISTRY
```
public static final CodecRegistry DEFAULT_BSON_CODEC_REGISTRY
```
    Default BSON codec registry for encoding/decoding arguments and results to/from MongoDB Realm backend.
    This will encode/decode most primitive types, list and map types and BsonValues.
    
    See Also:
    
    getDefaultCodecRegistry(), AppConfiguration.Builder.codecRegistry(CodecRegistry), ValueCodecProvider, BsonValueCodecProvider, IterableCodecProvider, MapCodecProvider, DocumentCodecProvider
  - loginObfuscators
```
public static final Map<String,RegexPatternObfuscator> loginObfuscators
```
    Default obfuscators for login requests used in a MongoDB Realm app.
    This map is needed to instantiate the default HttpLogObfuscator, which will keep all login-sensitive information from being shown in Logcat.
    This map's keys represent the different login identity providers which can be used to authenticate against an app and the values are the concrete obfuscators used for that provider.
    
    See Also:
    
    Credentials.Provider, RegexPatternObfuscator, ApiKeyObfuscator, TokenObfuscator, CustomFunctionObfuscator, EmailPasswordObfuscator, HttpLogObfuscator
- Method Detail
  - getAppId
```
public String getAppId()
```
    Returns the unique app id that identities the Realm application.
    
    Returns:
    
    the app unique identifier.
  - getAppName
```
public String getAppName()
```
    Returns the name used to describe the Realm application. This is only used as debug information.
    
    Returns:
    
    the app name.
  - getAppVersion
```
public String getAppVersion()
```
    Returns the version of this Realm application. This is only used as debug information.
    
    Returns:
    
    the app version.
  - getBaseUrl
```
public URL getBaseUrl()
```
    Returns the base url for this Realm application.
    
    Returns:
    
    the app base url.
  - getEncryptionKey
```
public byte[] getEncryptionKey()
```
    Returns the encryption key, if any, that is used to encrypt Realm users meta data on this device. If no key is returned, the data is not encrypted.
    
    Returns:
    
    the encryption key if exists, or null otherwise.
  - getRequestTimeoutMs
```
public long getRequestTimeoutMs()
```
    Returns the default timeout for network requests against the Realm application in milliseconds.
    
    Returns:
    
    the default timeout for network requests in milliseconds.
  - getAuthorizationHeaderName
```
public String getAuthorizationHeaderName()
```
    Returns the name of the header used to carry authentication data when making network requests towards MongoDB Realm.
    
    Returns:
    
    the authentication header name.
  - getCustomRequestHeaders
```
public Map<String,String> getCustomRequestHeaders()
```
    Returns any custom configured headers that will be sent alongside other headers when making network requests towards MongoDB Realm.
    
    Returns:
    
    a Map of custom configured headers.
  - getDefaultErrorHandler
```
public SyncSession.ErrorHandler getDefaultErrorHandler()
```
    Returns the default error handler used by synced Realms if there are problems with their SyncSession.
    
    Returns:
    
    the app default error handler.
  - getDefaultClientResetHandler
```
public SyncSession.ClientResetHandler getDefaultClientResetHandler()
```
    Returns the default Client Reset handler used by synced Realms if there are problems with their SyncSession.
    
    Returns:
    
    the app default error handler.
  - getSyncRootDirectory
```
public File getSyncRootDirectory()
```
    Returns the root folder containing all files and Realms used when synchronizing data between the device and MongoDB Realm.
    
    Returns:
    
    the sync root directory.
  - getDefaultCodecRegistry
```
public CodecRegistry getDefaultCodecRegistry()
```
    Returns the default codec registry used to encode and decode BSON arguments and results when calling remote Realm Functions and accessing a remote MongoDatabase.
    
    Returns:
    
    The default codec registry for the App.
    
    See Also:
    
    DEFAULT_BSON_CODEC_REGISTRY, getDefaultCodecRegistry()
  - getHttpLogObfuscator
```
public HttpLogObfuscator getHttpLogObfuscator()
```
    Returns the HttpLogObfuscator used in the app, which keeps sensitive information in HTTP requests from being displayed in the logcat.
    
    Returns:
    
    the HTTP log obfuscator.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AppConfiguration

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BASE_URL

DEFAULT_REQUEST_TIMEOUT

DEFAULT_AUTHORIZATION_HEADER_NAME

DEFAULT_BSON_CODEC_REGISTRY

loginObfuscators

Method Detail

getAppId

getAppName

getAppVersion

getBaseUrl

getEncryptionKey

getRequestTimeoutMs

getAuthorizationHeaderName

getCustomRequestHeaders

getDefaultErrorHandler

getDefaultClientResetHandler

getSyncRootDirectory

getDefaultCodecRegistry

getHttpLogObfuscator

equals

hashCode