PersistentCacheSettings.Builder
class PersistentCacheSettings.Builder
A Builder for creating PersistentCacheSettings instance.
Summary
Public functions |
|
|---|---|
PersistentCacheSettings |
build()Creates a |
PersistentCacheSettings.Builder |
setSizeBytes(sizeBytes: Long)Sets an approximate cache size threshold for the on-disk data. |
Public functions
build
fun build(): PersistentCacheSettings
Creates a PersistentCacheSettings instance from this builder instance.
setSizeBytes
fun setSizeBytes(sizeBytes: Long): PersistentCacheSettings.Builder
Sets an approximate cache size threshold for the on-disk data. If the cache grows beyond this size, Firestore SDK 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.
| Returns | |
|---|---|
PersistentCacheSettings.Builder |
A settings object on which the cache size is configured as specified by the given |