Stay organized with collections
Save and categorize content based on your preferences.
Firebase.Firestore.FirebaseFirestoreSettings
Settings used to configure a FirebaseFirestore instance.
Summary
Public static attributes
|
CacheSizeUnlimited = SettingsProxy.kCacheSizeUnlimited
|
readonly long
|
Properties
|
CacheSizeBytes
|
long
Sets an approximate cache size threshold for the on-disk data.
|
Host
|
string
|
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
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()
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-09-22 UTC.
[null,null,["Last updated 2021-09-22 UTC."],[],[],null,["# Firebase.Firestore.FirebaseFirestoreSettings Class Reference\n\nFirebase.Firestore.FirebaseFirestoreSettings\n============================================\n\nSettings used to configure a [FirebaseFirestore](/docs/reference/unity/class/firebase/firestore/firebase-firestore#class_firebase_1_1_firestore_1_1_firebase_firestore) instance.\n\nSummary\n-------\n\n| ### Public static attributes ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CacheSizeUnlimited](#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1aa27ed85eb86c8bb8bbd220e752bf923a)` = SettingsProxy.kCacheSizeUnlimited` | `readonly long` Constant to use when setting [FirebaseFirestoreSettings.CacheSizeBytes](/docs/reference/unity/class/firebase/firestore/firebase-firestore-settings#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1a2859ffcf1acad31d0d33dc4c72c7e438) to disable garbage collection. |\n\n| ### Properties ||\n|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| [CacheSizeBytes](#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1a2859ffcf1acad31d0d33dc4c72c7e438) | `long` Sets an approximate cache size threshold for the on-disk data. |\n| [Host](#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1a930ebf0a2af0328789bf5ccf48dcb4b3) | `string` The host of the Cloud [Firestore](/docs/reference/unity/namespace/firebase/firestore#namespace_firebase_1_1_firestore) backend. |\n| [PersistenceEnabled](#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1a00ff0b31f311b18ad2ac2a327e4324d9) | `bool` Whether or not to use local persistence storage. |\n| [SslEnabled](#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1abfcc256c8d70077d0ea45489198f934d) | `bool` Whether or not to use SSL for communication. |\n\n| ### Public functions ||\n|------------------------------------------------------------------------------------------------------------------|-------------------|\n| [ToString](#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1aa5a108acae866094c2dfa2a0a0ce1b4d)`()` | `override string` |\n\nPublic static attributes\n------------------------\n\n### CacheSizeUnlimited\n\n```c#\nreadonly long CacheSizeUnlimited = SettingsProxy.kCacheSizeUnlimited\n``` \nConstant to use when setting [FirebaseFirestoreSettings.CacheSizeBytes](/docs/reference/unity/class/firebase/firestore/firebase-firestore-settings#class_firebase_1_1_firestore_1_1_firebase_firestore_settings_1a2859ffcf1acad31d0d33dc4c72c7e438) to disable garbage collection.\n\nProperties\n----------\n\n### CacheSizeBytes\n\n```c#\nlong CacheSizeBytes\n``` \nSets an approximate cache size threshold for the on-disk data.\n\nIf the cache grows beyond this size, Cloud [Firestore](/docs/reference/unity/namespace/firebase/firestore#namespace_firebase_1_1_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.\n\nBy default, collection is enabled with a cache size of 100 MB. The minimum value is 1 MB.\n\nThis property must not be modified after calling non-static methods in the owning [FirebaseFirestore](/docs/reference/unity/class/firebase/firestore/firebase-firestore#class_firebase_1_1_firestore_1_1_firebase_firestore) object. Attempting to do so will result in an exception. \n\n### Host\n\n```c#\nstring Host\n``` \nThe host of the Cloud [Firestore](/docs/reference/unity/namespace/firebase/firestore#namespace_firebase_1_1_firestore) backend.\n\nThis property must not be modified after calling non-static methods in the owning [FirebaseFirestore](/docs/reference/unity/class/firebase/firestore/firebase-firestore#class_firebase_1_1_firestore_1_1_firebase_firestore) object. Attempting to do so will result in an exception. \n\n### PersistenceEnabled\n\n```c#\nbool PersistenceEnabled\n``` \nWhether or not to use local persistence storage.\n\nThis property must not be modified after calling non-static methods in the owning [FirebaseFirestore](/docs/reference/unity/class/firebase/firestore/firebase-firestore#class_firebase_1_1_firestore_1_1_firebase_firestore) object. Attempting to do so will result in an exception. \n\n### SslEnabled\n\n```c#\nbool SslEnabled\n``` \nWhether or not to use SSL for communication.\n\nThis property must not be modified after calling non-static methods in the owning [FirebaseFirestore](/docs/reference/unity/class/firebase/firestore/firebase-firestore#class_firebase_1_1_firestore_1_1_firebase_firestore) object. Attempting to do so will result in an exception.\n\nPublic functions\n----------------\n\n### ToString\n\n```c#\noverride string ToString()\n```"]]
