Settings class

Specifies custom configurations for your Cloud Firestore instance.

You must set these before invoking any other methods.

Annotations

• @immutable

Constructors

Settings({bool? persistenceEnabled, String? host, bool? sslEnabled, int? cacheSizeBytes, bool ignoreUndefinedProperties = false})

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 setter, override

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. 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.

no setter, inherited

sslEnabled → bool?

Whether to use SSL when connecting.

final

Methods

copyWith({bool? persistenceEnabled, String? host, bool? sslEnabled, int? cacheSizeBytes, bool? ignoreUndefinedProperties}) → 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.