Builder

class Builder(appId: String)

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

Parameters

appId

the application id of the App Services Application.

Constructors

Builder

fun Builder(appId: String)

the application id of the App Services Application.

Functions

appName

fun appName(appName: String): AppConfiguration.Builder

Sets the debug app name which is added to debug headers for App Services network requests.

appVersion

fun appVersion(appVersion: String): AppConfiguration.Builder

Sets the debug app version which is added to debug headers for App Services network requests.

baseUrl

fun baseUrl(baseUrl: String): AppConfiguration.Builder

Sets the base url for the App Services Application.

build

fun build(): AppConfiguration

Creates the AppConfiguration from the properties of the builder.

dispatcher

fun dispatcher(dispatcher: CoroutineDispatcher): AppConfiguration.Builder

The dispatcher used to execute internal tasks; most notably remote HTTP requests.

ejson

@ExperimentalRealmSerializerApi()

fun ejson(ejson: EJson): AppConfiguration.Builder

Sets the default EJson decoder that would be use to encode and decode arguments and results when calling remote Atlas Functions, authenticating with a customFunction, and retrieving a user profile or customData.

encryptionKey

fun encryptionKey(key: ByteArray): AppConfiguration.Builder

Sets the encryption key used to encrypt the user metadata Realm only.

httpLogObfuscator

fun httpLogObfuscator(httpLogObfuscator: HttpLogObfuscator?): AppConfiguration.Builder

Sets the a HttpLogObfuscator used to keep sensitive information in HTTP requests from being displayed in the log.

log

fun log(level: LogLevel = LogLevel.WARN, customLoggers: List<RealmLogger> = emptyList()): AppConfiguration.Builder

Configures how Realm will report log events for this App.

syncRootDirectory

fun syncRootDirectory(rootDir: String): AppConfiguration.Builder

Configures the root folder that marks the location of a mongodb-realm folder.