AppConfiguration class Application
A class exposing configuration options for an App
- Annotations
-
- @immutable
Constructors
-
AppConfiguration(String appId, {Uri? baseUrl, String? baseFilePath, Duration defaultRequestTimeout = const Duration(seconds: 60), List<
int> ? metadataEncryptionKey, MetadataPersistenceMode metadataPersistenceMode = MetadataPersistenceMode.plaintext, @Deprecated('Use SyncTimeoutOptions.connectTimeout') Duration maxConnectionTimeout = const Duration(minutes: 2), Client? httpClient, SyncTimeoutOptions syncTimeoutOptions = const SyncTimeoutOptions()}) - Instantiates a new AppConfiguration with the specified appId.
Properties
- appId → String
-
The appId is the unique id that identifies the Atlas App Services application.
final
- baseFilePath → String
-
The baseFilePath is the Directory relative to which all local data for this application will be stored.
final
- baseUrl → Uri
-
The baseUrl is the Uri used to reach the MongoDB Atlas.
final
- defaultRequestTimeout → Duration
-
The defaultRequestTimeout for HTTP requests. Defaults to 60 seconds.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpClient → Client
-
The
Clientthat will be used for HTTP requests during authentication.final - maxConnectionTimeout → Duration
-
The maximum duration to allow for a connection to
become fully established. This includes the time to resolve the
network address, the TCP connect operation, the SSL handshake, and
the WebSocket handshake. Defaults to 2 minutes.
final
-
metadataEncryptionKey
→ List<
int> ? -
The encryption key to use for user metadata on this device, if metadataPersistenceMode is
MetadataPersistenceMode.encrypted.
final
- metadataPersistenceMode → MetadataPersistenceMode
-
Enumeration that specifies how and if logged-in User objects are persisted across application launches.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- syncTimeoutOptions → SyncTimeoutOptions
-
Options for the assorted types of connection timeouts for sync connections opened for this app.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited