Settings class
Specifies custom configurations for your Cloud Firestore instance.
You must set these before invoking any other methods.
- Annotations
Constructors
- Settings({bool? persistenceEnabled, String? host, bool? sslEnabled, int? cacheSizeBytes, bool? webExperimentalForceLongPolling, bool? webExperimentalAutoDetectLongPolling, WebExperimentalLongPollingOptions? webExperimentalLongPollingOptions, bool ignoreUndefinedProperties = false, WebPersistentTabManager? webPersistentTabManager})
-
Creates an instance for these Settings.
const
Properties
-
asMap
→ Map<
String, dynamic> -
Returns the settings as a Map
no setter
- cacheSizeBytes → int?
-
An approximate cache size threshold for the on-disk data.
final
- hashCode → int
-
The hash code for this object.
no setteroverride
- host → String?
-
The hostname to connect to.
final
- ignoreUndefinedProperties → bool
-
Whether to skip nested properties that are set to undefined during object serialization.
final
- persistenceEnabled → bool?
-
Attempts to enable persistent storage, if possible.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sslEnabled → bool?
-
Whether to use SSL when connecting.
final
- webExperimentalAutoDetectLongPolling → bool?
-
Configures the SDK's underlying transport (WebChannel) to automatically detect if long-polling should be used.
final
- webExperimentalForceLongPolling → bool?
-
Forces the SDK’s underlying network transport (WebChannel) to use long-polling.
final
- webExperimentalLongPollingOptions → WebExperimentalLongPollingOptions?
-
Options that configure the SDK’s underlying network transport (WebChannel) when long-polling is used.
final
- webPersistentTabManager → WebPersistentTabManager?
-
Configures how multiple browser tabs are managed when using persistent
cache on web.
final
Methods
-
copyWith(
{bool? persistenceEnabled, String? host, bool? sslEnabled, int? cacheSizeBytes, bool? webExperimentalForceLongPolling, bool? webExperimentalAutoDetectLongPolling, bool? ignoreUndefinedProperties, WebExperimentalLongPollingOptions? webExperimentalLongPollingOptions, WebPersistentTabManager? webPersistentTabManager}) → Settings -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Constants
- CACHE_SIZE_UNLIMITED → const int
- Constant used to indicate the LRU garbage collection should be disabled.