Settings class Null safety

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})
Creates an instance for these Settings.
const

Properties

asMap Map<String, dynamic>
Returns the settings as a Map
read-only
cacheSizeBytes int?
An approximate cache size threshold for the on-disk data.
final
hashCode int
The hash code for this object.
read-only, override
host String?
The hostname to connect to.
final
persistenceEnabled bool?
Attempts to enable persistent storage, if possible. This setting has no effect on Web, for Web use FirebaseFirestore.enablePersistence instead.
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sslEnabled bool?
Whether to use SSL when connecting.
final

Methods

copyWith({bool? persistenceEnabled, String? host, bool? sslEnabled, int? cacheSizeBytes}) Settings
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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.
-1