Firebase.Firestore.FirebaseFirestoreSettings

Settings used to configure a FirebaseFirestore instance.

Summary

Public static attributes

CacheSizeUnlimited = SettingsProxy.kCacheSizeUnlimited
readonly long
Constant to use when setting FirebaseFirestoreSettings.CacheSizeBytes to disable garbage collection.

Properties

CacheSizeBytes
long
Sets an approximate cache size threshold for the on-disk data.
Host
string
The host of the Cloud Firestore backend.
PersistenceEnabled
bool
Whether or not to use local persistence storage.
SslEnabled
bool
Whether or not to use SSL for communication.

Public functions

ToString()
override string

Public static attributes

CacheSizeUnlimited

readonly long CacheSizeUnlimited = SettingsProxy.kCacheSizeUnlimited

Constant to use when setting FirebaseFirestoreSettings.CacheSizeBytes to disable garbage collection.

Properties

CacheSizeBytes

long CacheSizeBytes

Sets an approximate cache size threshold for the on-disk data.

If the cache grows beyond this size, Cloud Firestore will start removing data that hasn't been recently used. The size is not a guarantee that the cache will stay below that size, only that if the cache exceeds the given size, cleanup will be attempted.

By default, collection is enabled with a cache size of 100 MB. The minimum value is 1 MB.

This property must not be modified after calling non-static methods in the owning FirebaseFirestore object. Attempting to do so will result in an exception.

Host

string Host

The host of the Cloud Firestore backend.

This property must not be modified after calling non-static methods in the owning FirebaseFirestore object. Attempting to do so will result in an exception.

PersistenceEnabled

bool PersistenceEnabled

Whether or not to use local persistence storage.

This property must not be modified after calling non-static methods in the owning FirebaseFirestore object. Attempting to do so will result in an exception.

SslEnabled

bool SslEnabled

Whether or not to use SSL for communication.

This property must not be modified after calling non-static methods in the owning FirebaseFirestore object. Attempting to do so will result in an exception.

Public functions

ToString

override string ToString()