AppConfiguration

An AppConfiguration is used to setup linkage to an Atlas App Services Application.

Instances of an AppConfiguration can be created by using the AppConfiguration.Builder and calling its AppConfiguration.Builder.build method or by using AppConfiguration.create.

Types

Link copied to clipboard
class Builder(appId: String)

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

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val appId: String
Link copied to clipboard
abstract val appName: String?

The name of app. This is only used for debugging.

Link copied to clipboard
abstract val appVersion: String?

The version of the app. This is only used for debugging.

Link copied to clipboard

Authorization header name used for Atlas App services requests.

Link copied to clipboard
abstract val baseUrl: String
Link copied to clipboard

Custom configured headers that will be sent alongside other headers when making network requests towards Atlas App services.

Link copied to clipboard
abstract val ejson: EJson

The default EJson decoder that would be used to encode and decode arguments and results when calling remote App Functions, authenticating with a customFunction, and retrieving a user profile or customData.

Link copied to clipboard

If enabled, a single connection is used for all Realms opened with a single sync user. If disabled, a separate connection is used for each Realm.

Link copied to clipboard
abstract val encryptionKey: ByteArray?
Link copied to clipboard

The configured HttpLogObfuscator for this app. If this property returns null no obfuscator is being used.

Link copied to clipboard
abstract val metadataMode: MetadataMode
Link copied to clipboard
Link copied to clipboard

The configured timeouts for various aspects of the sync connection from realms.