New cache config API #4869
Merged
New cache config API #4869
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2023-04-14 14:34:59.000000000 +0000
@@ -10,6 +10,8 @@
path: "/docs/reference/android/com/google/firebase/firestore/EventListener.html"
- title: "ListenerRegistration"
path: "/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html"
+ - title: "LocalCacheSettings"
+ path: "/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html"
- title: "OnProgressListener"
path: "/docs/reference/android/com/google/firebase/firestore/OnProgressListener.html"
- title: "Transaction.Function"
@@ -52,6 +54,14 @@
path: "/docs/reference/android/com/google/firebase/firestore/LoadBundleTask.html"
- title: "LoadBundleTaskProgress"
path: "/docs/reference/android/com/google/firebase/firestore/LoadBundleTaskProgress.html"
+ - title: "MemoryCacheSettings"
+ path: "/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html"
+ - title: "MemoryCacheSettings.Builder"
+ path: "/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html"
+ - title: "PersistentCacheSettings"
+ path: "/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html"
+ - title: "PersistentCacheSettings.Builder"
+ path: "/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html"
- title: "Query"
path: "/docs/reference/android/com/google/firebase/firestore/Query.html"
- title: "QueryDocumentSnapshot"--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html 2023-04-14 14:34:59.000000000 +0000
@@ -89,7 +89,10 @@
<tr>
<td><code>long</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#getCacheSizeBytes()">getCacheSizeBytes</a>()</code></div>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#getCacheSizeBytes()">getCacheSizeBytes</a></del></span>()</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Build the <code>FirebaseFirestoreSettings</code> instance to check cache configurations.</p>
+ </p>
</td>
</tr>
<tr>
@@ -101,7 +104,10 @@
<tr>
<td><code>boolean</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a>()</code></div>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>()</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Build the <code>FirebaseFirestoreSettings</code> instance to check cache configurations.</p>
+ </p>
</td>
</tr>
<tr>
@@ -113,8 +119,10 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setCacheSizeBytes(long)">setCacheSizeBytes</a>(long value)</code></div>
- <p>Sets an approximate cache size threshold for the on-disk data.</p>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setCacheSizeBytes(long)">setCacheSizeBytes</a></del></span>(long value)</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code> to configure SDK cache instead.</p>
+ </p>
</td>
</tr>
<tr>
@@ -127,8 +135,17 @@
<tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a>(boolean value)</code></div>
- <p>Enables or disables local persistent storage.</p>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a> settings)</code></div>
+ <p>Specifies the cache used by the SDK.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
+ <td>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a></del></span>(boolean value)</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code> to configure SDK cache instead.</p>
+ </p>
</td>
</tr>
<tr>
@@ -174,7 +191,10 @@
</div>
<div class="api-item"><a name="getCacheSizeBytes--"></a><a name="getcachesizebytes"></a>
<h3 class="api-name" id="getCacheSizeBytes()">getCacheSizeBytes</h3>
- <pre class="api-signature no-pretty-print">public long <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#getCacheSizeBytes()">getCacheSizeBytes</a>()</pre>
+ <pre class="api-signature no-pretty-print">public long <span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#getCacheSizeBytes()">getCacheSizeBytes</a></del></span>()</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Build the <code>FirebaseFirestoreSettings</code> instance to check cache configurations.</p>
+ </aside>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -224,7 +244,10 @@
</div>
<div class="api-item"><a name="isPersistenceEnabled--"></a><a name="ispersistenceenabled"></a>
<h3 class="api-name" id="isPersistenceEnabled()">isPersistenceEnabled</h3>
- <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a>()</pre>
+ <pre class="api-signature no-pretty-print">public boolean <span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>()</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Build the <code>FirebaseFirestoreSettings</code> instance to check cache configurations.</p>
+ </aside>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -274,7 +297,10 @@
</div>
<div class="api-item"><a name="setCacheSizeBytes-long-"></a><a name="setcachesizebytes"></a>
<h3 class="api-name" id="setCacheSizeBytes(long)">setCacheSizeBytes</h3>
- <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setCacheSizeBytes(long)">setCacheSizeBytes</a>(long value)</pre>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a> <span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setCacheSizeBytes(long)">setCacheSizeBytes</a></del></span>(long value)</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code> to configure SDK cache instead.</p>
+ </aside>
<p>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. </p>
<p>By default, collection is enabled with a cache size of 100 MB. The minimum value is 1 MB.</p>
<div class="devsite-table-wrapper">
@@ -346,9 +372,40 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="setLocalCacheSettings-com.google.firebase.firestore.LocalCacheSettings-"></a><a name="setlocalcachesettings"></a>
+ <h3 class="api-name" id="setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a> settings)</pre>
+ <p>Specifies the cache used by the SDK. Available options are <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> and <code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code>, each with different configuration options. </p>
+ <p>When unspecified, <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> will be used by default. </p>
+ <p>NOTE: Calling this setter and <code>setPersistenceEnabled()</code> or @{code setCacheSizeBytes()} at the same time will throw an exception during SDK initialization. Instead, use the configuration in the <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> object to specify the cache size.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
+ <td>
+ <p>A settings object on which the cache settings is configured as specified by the given <code>settings</code>.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="setPersistenceEnabled-boolean-"></a><a name="setpersistenceenabled"></a>
<h3 class="api-name" id="setPersistenceEnabled(boolean)">setPersistenceEnabled</h3>
- <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a>(boolean value)</pre>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a> <span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a></del></span>(boolean value)</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code> to configure SDK cache instead.</p>
+ </aside>
<p>Enables or disables local persistent storage. The default is to use local persistent storage.</p>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -69,6 +69,12 @@
</thead>
<tbody class="list">
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSettings()">cacheSettings</a></code></div>
+ </td>
+ </tr>
+ <tr>
<td><code>final long</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSizeBytes()">cacheSizeBytes</a></code></div>
@@ -98,14 +104,23 @@
<tr>
<td><code>boolean</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> o)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> o)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a>()</code></div>
+ <p>Returns the cache settings configured for the SDK.</p>
</td>
</tr>
<tr>
<td><code>long</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSizeBytes()">getCacheSizeBytes</a>()</code></div>
- <p>Returns the threshold for the cache size above which the SDK will attempt to collect the least recently used documents.</p>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSizeBytes()">getCacheSizeBytes</a></del></span>()</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a></code> instead.</p>
+ </p>
</td>
</tr>
<tr>
@@ -124,8 +139,10 @@
<tr>
<td><code>boolean</code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a>()</code></div>
- <p>Returns whether or not to use local persistent storage.</p>
+ <div><code><span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>()</code></div>
+ <p><strong>This method is deprecated.</strong>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a></code> instead.</p>
+ </p>
</td>
</tr>
<tr>
@@ -154,6 +171,10 @@
</div>
<div class="list">
<h2>Public fields</h2>
+ <div class="api-item"><a name="getCacheSettings()"></a><a name="setCacheSettings()"></a><a name="getCacheSettings--"></a><a name="setCacheSettings--"></a>
+ <h3 class="api-name" id="cacheSettings()">cacheSettings</h3>
+ <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSettings()">cacheSettings</a></pre>
+ </div>
<div class="api-item"><a name="getCacheSizeBytes()"></a><a name="setCacheSizeBytes()"></a><a name="getCacheSizeBytes--"></a><a name="setCacheSizeBytes--"></a>
<h3 class="api-name" id="cacheSizeBytes()">cacheSizeBytes</h3>
<pre class="api-signature no-pretty-print">public final long <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSizeBytes()">cacheSizeBytes</a></pre>
@@ -167,11 +188,19 @@
<h2>Public methods</h2>
<div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
<h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
- <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> o)</pre>
+ <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> o)</pre>
+ </div>
+ <div class="api-item"><a name="getCacheSettings--"></a><a name="getcachesettings"></a>
+ <h3 class="api-name" id="getCacheSettings()">getCacheSettings</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a>()</pre>
+ <p>Returns the cache settings configured for the SDK. Returns null if it is not configured, in which case a default <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> instance is used.</p>
</div>
<div class="api-item"><a name="getCacheSizeBytes--"></a><a name="getcachesizebytes"></a>
<h3 class="api-name" id="getCacheSizeBytes()">getCacheSizeBytes</h3>
- <pre class="api-signature no-pretty-print">public long <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSizeBytes()">getCacheSizeBytes</a>()</pre>
+ <pre class="api-signature no-pretty-print">public long <span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSizeBytes()">getCacheSizeBytes</a></del></span>()</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a></code> instead.</p>
+ </aside>
<p>Returns the threshold for the cache size above which the SDK will attempt to collect the least recently used documents.</p>
</div>
<div class="api-item"><a name="getHost--"></a><a name="gethost"></a>
@@ -185,7 +214,10 @@
</div>
<div class="api-item"><a name="isPersistenceEnabled--"></a><a name="ispersistenceenabled"></a>
<h3 class="api-name" id="isPersistenceEnabled()">isPersistenceEnabled</h3>
- <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a>()</pre>
+ <pre class="api-signature no-pretty-print">public boolean <span><del><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>()</pre>
+ <aside class="caution"><strong>This method is deprecated.</strong><br>
+ <p>Use <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a></code> instead.</p>
+ </aside>
<p>Returns whether or not to use local persistent storage.</p>
</div>
<div class="api-item"><a name="isSslEnabled--"></a><a name="issslenabled"></a>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/LocalCacheSettings.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/LocalCacheSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,46 @@
+<html devsite="true">
+ <head>
+ <title>LocalCacheSettings</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>LocalCacheSettings</h1>
+ <p>
+ <pre>public interface <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></pre>
+ </p>
+ <div class="devsite-table-wrapper"><devsite-expandable><span class="expand-control jd-sumtable-subclasses">Known direct subclasses
+ <div class="showalways" id="subclasses-direct"><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a>, <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></div>
+ </span>
+ <div id="subclasses-direct-summary">
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a memory cache.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a persistent cache.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+</devsite-expandable> </div>
+ <hr>
+ <p>Marker interface implemented by all supported cache settings. </p>
+ <p>The two cache types supported are <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> and . Custom implementation is not supported by the SDK.</p>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,48 @@
+<html devsite="true">
+ <head>
+ <title>MemoryCacheSettings.Builder</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>MemoryCacheSettings.Builder</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></pre>
+ </p>
+ <hr>
+ <p>A Builder for creating <code>MemoryCacheSettings</code> instance.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html#build()">build</a>()</code></div>
+ <p>Creates a <code>MemoryCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="build--"></a><a name="build"></a>
+ <h3 class="api-name" id="build()">build</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html#build()">build</a>()</pre>
+ <p>Creates a <code>MemoryCacheSettings</code> instance.</p>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryCacheSettings.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/MemoryCacheSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,100 @@
+<html devsite="true">
+ <head>
+ <title>MemoryCacheSettings</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>MemoryCacheSettings</h1>
+ <p>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a> implements <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></pre>
+ </p>
+ <hr>
+ <p>Configures the SDK to use a memory cache. Firestore documents and mutations are NOT persisted across App restart. </p>
+ <p>To use, create an instance using <code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#newBuilder()">newBuilder</a></code>, then set the instance to <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code>, and use the built `FirebaseFirestoreSettings` instance to configure Firestore SDK.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>public class <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code></div>
+ <p>A Builder for creating <code>MemoryCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#equals(java.lang.Object)">equals</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#hashCode()">hashCode</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#newBuilder()">newBuilder</a>()</code></div>
+ <p>Returns a new instance of <code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code> with default configurations.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#toString()">toString</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#equals(java.lang.Object)">equals</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> obj)</pre>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">public int <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#hashCode()">hashCode</a>()</pre>
+ </div>
+ <div class="api-item"><a name="newBuilder--"></a><a name="newbuilder"></a>
+ <h3 class="api-name" id="newBuilder()">newBuilder</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#newBuilder()">newBuilder</a>()</pre>
+ <p>Returns a new instance of <code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code> with default configurations.</p>
+ </div>
+ <div class="api-item"><a name="toString--"></a><a name="tostring"></a>
+ <h3 class="api-name" id="toString()">toString</h3>
+ <pre class="api-signature no-pretty-print">public <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html#toString()">toString</a>()</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,82 @@
+<html devsite="true">
+ <head>
+ <title>PersistentCacheSettings.Builder</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>PersistentCacheSettings.Builder</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></pre>
+ </p>
+ <hr>
+ <p>A Builder for creating <code>PersistentCacheSettings</code> instance.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#build()">build</a>()</code></div>
+ <p>Creates a <code>PersistentCacheSettings</code> instance from this builder instance.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(long sizeBytes)</code></div>
+ <p>Sets an approximate cache size threshold for the on-disk data.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="build--"></a><a name="build"></a>
+ <h3 class="api-name" id="build()">build</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#build()">build</a>()</pre>
+ <p>Creates a <code>PersistentCacheSettings</code> instance from this builder instance.</p>
+ </div>
+ <div class="api-item"><a name="setSizeBytes-long-"></a><a name="setsizebytes"></a>
+ <h3 class="api-name" id="setSizeBytes(long)">setSizeBytes</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(long sizeBytes)</pre>
+ <p>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. </p>
+ <p>By default, collection is enabled with a cache size of 100 MB. The minimum value is 1 MB.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <p>A settings object on which the cache size is configured as specified by the given <code>value</code>.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/PersistentCacheSettings.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/PersistentCacheSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,142 @@
+<html devsite="true">
+ <head>
+ <title>PersistentCacheSettings</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>PersistentCacheSettings</h1>
+ <p>
+ <pre>public final class <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a> implements <a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></pre>
+ </p>
+ <hr>
+ <p>Configures the SDK to use a persistent cache. Firestore documents and mutations are persisted across App restart. </p>
+ <p>This is the default cache type unless explicitly specified otherwise. </p>
+ <p>To use, create an instance using <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#newBuilder()">newBuilder</a></code>, then set the instance to <code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code>, and use the built `FirebaseFirestoreSettings` instance to configure Firestore SDK.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>public class <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></div>
+ <p>A Builder for creating <code>PersistentCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public fields</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>final long</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#sizeBytes()">sizeBytes</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> o)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>long</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#getSizeBytes()">getSizeBytes</a>()</code></div>
+ <p>Returns cache size threshold for the on-disk data.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#hashCode()">hashCode</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#newBuilder()">newBuilder</a>()</code></div>
+ <p>Returns a new instance of <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code> with default configurations.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#toString()">toString</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getSizeBytes()"></a><a name="setSizeBytes()"></a><a name="getSizeBytes--"></a><a name="setSizeBytes--"></a>
+ <h3 class="api-name" id="sizeBytes()">sizeBytes</h3>
+ <pre class="api-signature no-pretty-print">public final long <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#sizeBytes()">sizeBytes</a></pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> o)</pre>
+ </div>
+ <div class="api-item"><a name="getSizeBytes--"></a><a name="getsizebytes"></a>
+ <h3 class="api-name" id="getSizeBytes()">getSizeBytes</h3>
+ <pre class="api-signature no-pretty-print">public long <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#getSizeBytes()">getSizeBytes</a>()</pre>
+ <p>Returns 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. </p>
+ <p>By default, persistent cache is enabled with a cache size of 100 MB. The minimum value is 1 MB.</p>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">public int <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#hashCode()">hashCode</a>()</pre>
+ </div>
+ <div class="api-item"><a name="newBuilder--"></a><a name="newbuilder"></a>
+ <h3 class="api-name" id="newBuilder()">newBuilder</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#newBuilder()">newBuilder</a>()</pre>
+ <p>Returns a new instance of <code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code> with default configurations.</p>
+ </div>
+ <div class="api-item"><a name="toString--"></a><a name="tostring"></a>
+ <h3 class="api-name" id="toString()">toString</h3>
+ <pre class="api-signature no-pretty-print">public <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html#toString()">toString</a>()</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2023-04-14 14:34:59.000000000 +0000
@@ -74,6 +74,12 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></code></td>
+ <td>
+ <p>Marker interface implemented by all supported cache settings.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/OnProgressListener.html">OnProgressListener</a></code></td>
<td>
<p>A listener that is called periodically during execution of a <code><a href="/docs/reference/android/com/google/firebase/firestore/LoadBundleTask.html">LoadBundleTask</a></code>.</p>
@@ -200,6 +206,30 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a memory cache.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code></td>
+ <td>
+ <p>A Builder for creating <code>MemoryCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a persistent cache.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <p>A Builder for creating <code>PersistentCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a></code></td>
<td>
<p>A <code>Query</code> which you can read or listen to.</p>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2023-04-14 14:34:59.000000000 +0000
@@ -10,6 +10,8 @@
path: "/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html"
- title: "ListenerRegistration"
path: "/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html"
+ - title: "LocalCacheSettings"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html"
- title: "OnProgressListener"
path: "/docs/reference/kotlin/com/google/firebase/firestore/OnProgressListener.html"
- title: "Transaction.Function"
@@ -52,6 +54,14 @@
path: "/docs/reference/kotlin/com/google/firebase/firestore/LoadBundleTask.html"
- title: "LoadBundleTaskProgress"
path: "/docs/reference/kotlin/com/google/firebase/firestore/LoadBundleTaskProgress.html"
+ - title: "MemoryCacheSettings"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html"
+ - title: "MemoryCacheSettings.Builder"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html"
+ - title: "PersistentCacheSettings"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html"
+ - title: "PersistentCacheSettings.Builder"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html"
- title: "Query"
path: "/docs/reference/kotlin/com/google/firebase/firestore/Query.html"
- title: "QueryDocumentSnapshot"--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html 2023-04-14 14:34:59.000000000 +0000
@@ -62,7 +62,10 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a>()</code></div>
+ <div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>()</code></div>
+ <p><strong>This function is deprecated.</strong>
+ <p>Build the <code>FirebaseFirestoreSettings</code> instance to check cache configurations.</p>
+ </p>
</td>
</tr>
<tr>
@@ -74,8 +77,17 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div>
- <p>Enables or disables local persistent storage.</p>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a>(settings: <a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a>)</code></div>
+ <p>Specifies the cache used by the SDK.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
+ <td>
+ <div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a></del></span>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div>
+ <p><strong>This function is deprecated.</strong>
+ <p>Use <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code> to configure SDK cache instead.</p>
+ </p>
</td>
</tr>
<tr>
@@ -137,7 +149,10 @@
</div>
<div class="api-item"><a name="isPersistenceEnabled--"></a><a name="ispersistenceenabled"></a>
<h3 class="api-name" id="isPersistenceEnabled()">isPersistenceEnabled</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <pre class="api-signature no-pretty-print">fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>
+ <p>Build the <code>FirebaseFirestoreSettings</code> instance to check cache configurations.</p>
+ </aside>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -185,9 +200,40 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="setLocalCacheSettings-com.google.firebase.firestore.LocalCacheSettings-"></a><a name="setlocalcachesettings"></a>
+ <h3 class="api-name" id="setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a>(settings: <a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></pre>
+ <p>Specifies the cache used by the SDK. Available options are <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> and <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code>, each with different configuration options. </p>
+ <p>When unspecified, <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> will be used by default. </p>
+ <p>NOTE: Calling this setter and <code>setPersistenceEnabled()</code> or @{code setCacheSizeBytes()} at the same time will throw an exception during SDK initialization. Instead, use the configuration in the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> object to specify the cache size.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></code></td>
+ <td>
+ <p>A settings object on which the cache settings is configured as specified by the given <code>settings</code>.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="setPersistenceEnabled-boolean-"></a><a name="setpersistenceenabled"></a>
<h3 class="api-name" id="setPersistenceEnabled(boolean)">setPersistenceEnabled</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></pre>
+ <pre class="api-signature no-pretty-print">fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setPersistenceEnabled(boolean)">setPersistenceEnabled</a></del></span>(value: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a></pre>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>
+ <p>Use <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code> to configure SDK cache instead.</p>
+ </aside>
<p>Enables or disables local persistent storage. The default is to use local persistent storage.</p>
<div class="devsite-table-wrapper">
<table class="responsive">--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -71,7 +71,7 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(o: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(o: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
</td>
</tr>
<tr>
@@ -83,8 +83,10 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a>()</code></div>
- <p>Returns whether or not to use local persistent storage.</p>
+ <div><code><span><del><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>()</code></div>
+ <p><strong>This function is deprecated.</strong>
+ <p>Use <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a></code> instead.</p>
+ </p>
</td>
</tr>
<tr>
@@ -116,6 +118,12 @@
</thead>
<tbody class="list">
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSettings()">cacheSettings</a></code></div>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSizeBytes()">cacheSizeBytes</a></code></div>
@@ -142,7 +150,7 @@
<h2>Public functions</h2>
<div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
<h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(o: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#equals(java.lang.Object)">equals</a>(o: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
</div>
<div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
<h3 class="api-name" id="hashCode()">hashCode</h3>
@@ -150,7 +158,10 @@
</div>
<div class="api-item"><a name="isPersistenceEnabled--"></a><a name="ispersistenceenabled"></a>
<h3 class="api-name" id="isPersistenceEnabled()">isPersistenceEnabled</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <pre class="api-signature no-pretty-print">fun <span><del><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#isPersistenceEnabled()">isPersistenceEnabled</a></del></span>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ <aside class="caution"><strong>This function is deprecated.</strong><br>
+ <p>Use <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#getCacheSettings()">getCacheSettings</a></code> instead.</p>
+ </aside>
<p>Returns whether or not to use local persistent storage.</p>
</div>
<div class="api-item"><a name="isSslEnabled--"></a><a name="issslenabled"></a>
@@ -165,6 +176,10 @@
</div>
<div class="list">
<h2>Public properties</h2>
+ <div class="api-item"><a name="getCacheSettings()"></a><a name="setCacheSettings()"></a><a name="getCacheSettings--"></a><a name="setCacheSettings--"></a>
+ <h3 class="api-name" id="cacheSettings()">cacheSettings</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSettings()">cacheSettings</a>: <a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a>!</pre>
+ </div>
<div class="api-item"><a name="getCacheSizeBytes()"></a><a name="setCacheSizeBytes()"></a><a name="getCacheSizeBytes--"></a><a name="setCacheSizeBytes--"></a>
<h3 class="api-name" id="cacheSizeBytes()">cacheSizeBytes</h3>
<pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html#cacheSizeBytes()">cacheSizeBytes</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></pre>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/LocalCacheSettings.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/LocalCacheSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,46 @@
+<html devsite="true">
+ <head>
+ <title>LocalCacheSettings</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>LocalCacheSettings</h1>
+ <p>
+ <pre>interface <a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></pre>
+ </p>
+ <div class="devsite-table-wrapper"><devsite-expandable><span class="expand-control jd-sumtable-subclasses">Known direct subclasses
+ <div class="showalways" id="subclasses-direct"><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a>, <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></div>
+ </span>
+ <div id="subclasses-direct-summary">
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a memory cache.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a persistent cache.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+</devsite-expandable> </div>
+ <hr>
+ <p>Marker interface implemented by all supported cache settings. </p>
+ <p>The two cache types supported are <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code> and . Custom implementation is not supported by the SDK.</p>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,48 @@
+<html devsite="true">
+ <head>
+ <title>MemoryCacheSettings.Builder</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>MemoryCacheSettings.Builder</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></pre>
+ </p>
+ <hr>
+ <p>A Builder for creating <code>MemoryCacheSettings</code> instance.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html#build()">build</a>()</code></div>
+ <p>Creates a <code>MemoryCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="build--"></a><a name="build"></a>
+ <h3 class="api-name" id="build()">build</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html#build()">build</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></pre>
+ <p>Creates a <code>MemoryCacheSettings</code> instance.</p>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,100 @@
+<html devsite="true">
+ <head>
+ <title>MemoryCacheSettings</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>MemoryCacheSettings</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></pre>
+ </p>
+ <hr>
+ <p>Configures the SDK to use a memory cache. Firestore documents and mutations are NOT persisted across App restart. </p>
+ <p>To use, create an instance using <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#newBuilder()">newBuilder</a></code>, then set the instance to <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code>, and use the built `FirebaseFirestoreSettings` instance to configure Firestore SDK.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code></div>
+ <p>A Builder for creating <code>MemoryCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#equals(java.lang.Object)">equals</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#hashCode()">hashCode</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#newBuilder()">newBuilder</a>()</code></div>
+ <p>Returns a new instance of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code> with default configurations.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#toString()">toString</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#equals(java.lang.Object)">equals</a>(obj: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#hashCode()">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
+ </div>
+ <div class="api-item"><a name="newBuilder--"></a><a name="newbuilder"></a>
+ <h3 class="api-name" id="newBuilder()">newBuilder</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#newBuilder()">newBuilder</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></pre>
+ <p>Returns a new instance of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code> with default configurations.</p>
+ </div>
+ <div class="api-item"><a name="toString--"></a><a name="tostring"></a>
+ <h3 class="api-name" id="toString()">toString</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html#toString()">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,82 @@
+<html devsite="true">
+ <head>
+ <title>PersistentCacheSettings.Builder</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>PersistentCacheSettings.Builder</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></pre>
+ </p>
+ <hr>
+ <p>A Builder for creating <code>PersistentCacheSettings</code> instance.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#build()">build</a>()</code></div>
+ <p>Creates a <code>PersistentCacheSettings</code> instance from this builder instance.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(sizeBytes: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>)</code></div>
+ <p>Sets an approximate cache size threshold for the on-disk data.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="build--"></a><a name="build"></a>
+ <h3 class="api-name" id="build()">build</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#build()">build</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></pre>
+ <p>Creates a <code>PersistentCacheSettings</code> instance from this builder instance.</p>
+ </div>
+ <div class="api-item"><a name="setSizeBytes-long-"></a><a name="setsizebytes"></a>
+ <h3 class="api-name" id="setSizeBytes(long)">setSizeBytes</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html#setSizeBytes(long)">setSizeBytes</a>(sizeBytes: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></pre>
+ <p>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. </p>
+ <p>By default, collection is enabled with a cache size of 100 MB. The minimum value is 1 MB.</p>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%">Returns</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <p>A settings object on which the cache size is configured as specified by the given <code>value</code>.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html 2023-04-14 14:34:59.000000000 +0000
@@ -0,0 +1,129 @@
+<html devsite="true">
+ <head>
+ <title>PersistentCacheSettings</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>PersistentCacheSettings</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></pre>
+ </p>
+ <hr>
+ <p>Configures the SDK to use a persistent cache. Firestore documents and mutations are persisted across App restart. </p>
+ <p>This is the default cache type unless explicitly specified otherwise. </p>
+ <p>To use, create an instance using <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#newBuilder()">newBuilder</a></code>, then set the instance to <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html#setLocalCacheSettings(com.google.firebase.firestore.LocalCacheSettings)">setLocalCacheSettings</a></code>, and use the built `FirebaseFirestoreSettings` instance to configure Firestore SDK.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></div>
+ <p>A Builder for creating <code>PersistentCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#equals(java.lang.Object)">equals</a>(o: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#hashCode()">hashCode</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#newBuilder()">newBuilder</a>()</code></div>
+ <p>Returns a new instance of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code> with default configurations.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#toString()">toString</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public properties</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#sizeBytes()">sizeBytes</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#equals(java.lang.Object)">equals</a>(o: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#hashCode()">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
+ </div>
+ <div class="api-item"><a name="newBuilder--"></a><a name="newbuilder"></a>
+ <h3 class="api-name" id="newBuilder()">newBuilder</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#newBuilder()">newBuilder</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></pre>
+ <p>Returns a new instance of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code> with default configurations.</p>
+ </div>
+ <div class="api-item"><a name="toString--"></a><a name="tostring"></a>
+ <h3 class="api-name" id="toString()">toString</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#toString()">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!</pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getSizeBytes()"></a><a name="setSizeBytes()"></a><a name="getSizeBytes--"></a><a name="setSizeBytes--"></a>
+ <h3 class="api-name" id="sizeBytes()">sizeBytes</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html#sizeBytes()">sizeBytes</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/ktx/package-summary.html 2023-04-14 14:42:14.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/ktx/package-summary.html 2023-04-14 14:37:23.000000000 +0000
@@ -21,6 +21,18 @@
<p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html">FirebaseFirestoreSettings</a></code> instance initialized using the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#firestoreSettings(kotlin.Function1)">init</a></code> function.</p>
</td>
</tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#memoryCacheSettings(kotlin.Function1)">memoryCacheSettings</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#persistentCacheSettings(kotlin.Function1)">persistentCacheSettings</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>)</code></div>
+ </td>
+ </tr>
</tbody>
</table>
</div>
@@ -164,6 +176,14 @@
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#firestoreSettings(kotlin.Function1)">firestoreSettings</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.Builder.html">FirebaseFirestoreSettings.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html">FirebaseFirestoreSettings</a></pre>
<p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreSettings.html">FirebaseFirestoreSettings</a></code> instance initialized using the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#firestoreSettings(kotlin.Function1)">init</a></code> function.</p>
</div>
+ <div class="api-item"><a name="memoryCacheSettings-kotlin.Function1-"></a><a name="memorycachesettings"></a>
+ <h3 class="api-name" id="memoryCacheSettings(kotlin.Function1)">memoryCacheSettings</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#memoryCacheSettings(kotlin.Function1)">memoryCacheSettings</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></pre>
+ </div>
+ <div class="api-item"><a name="persistentCacheSettings-kotlin.Function1-"></a><a name="persistentcachesettings"></a>
+ <h3 class="api-name" id="persistentCacheSettings(kotlin.Function1)">persistentCacheSettings</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/ktx/package-summary.html#persistentCacheSettings(kotlin.Function1)">persistentCacheSettings</a>(init: <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a>.() <span style="white-space: nowrap;">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></pre>
+ </div>
<h2>Extension functions</h2>
<div class="api-item"><a name="-com.google.firebase.firestore.DocumentReference-.dataObjects-com.google.firebase.firestore.MetadataChanges-"></a><a name="dataobjects"></a>
<h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).dataObjects(com.google.firebase.firestore.MetadataChanges)">dataObjects</h3>
@@ -171,7 +191,7 @@
<p>Starts listening to the document referenced by this <code>DocumentReference</code> with the given options and emits its values converted to a POJO via a <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code>.</p>
<ul>
<li>
- <p>When the returned flow starts being collected, an EventListener will be attached.</p>
+ <p>When the returned flow starts being collected, an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code> will be attached.</p>
</li>
<li>
<p>When the flow completes, the listener will be removed.</p>
@@ -211,7 +231,7 @@
<p>Starts listening to this query with the given options and emits its values converted to a POJO via a <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code>.</p>
<ul>
<li>
- <p>When the returned flow starts being collected, an EventListener will be attached.</p>
+ <p>When the returned flow starts being collected, an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code> will be attached.</p>
</li>
<li>
<p>When the flow completes, the listener will be removed.</p>
@@ -442,7 +462,7 @@
<p>Starts listening to the document referenced by this <code>DocumentReference</code> with the given options and emits its values via a <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code>.</p>
<ul>
<li>
- <p>When the returned flow starts being collected, an EventListener will be attached.</p>
+ <p>When the returned flow starts being collected, an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code> will be attached.</p>
</li>
<li>
<p>When the flow completes, the listener will be removed.</p>
@@ -476,7 +496,7 @@
<p>Starts listening to this query with the given options and emits its values via a <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code>.</p>
<ul>
<li>
- <p>When the returned flow starts being collected, an EventListener will be attached.</p>
+ <p>When the returned flow starts being collected, an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code> will be attached.</p>
</li>
<li>
<p>When the flow completes, the listener will be removed.</p>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2023-04-14 14:40:37.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2023-04-14 14:34:59.000000000 +0000
@@ -27,6 +27,12 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/LocalCacheSettings.html">LocalCacheSettings</a></code></td>
+ <td>
+ <p>Marker interface implemented by all supported cache settings.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/OnProgressListener.html">OnProgressListener</a></code></td>
<td>
<p>A listener that is called periodically during execution of a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/LoadBundleTask.html">LoadBundleTask</a></code>.</p>
@@ -153,6 +159,30 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.html">MemoryCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a memory cache.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MemoryCacheSettings.Builder.html">MemoryCacheSettings.Builder</a></code></td>
+ <td>
+ <p>A Builder for creating <code>MemoryCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.html">PersistentCacheSettings</a></code></td>
+ <td>
+ <p>Configures the SDK to use a persistent cache.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/PersistentCacheSettings.Builder.html">PersistentCacheSettings.Builder</a></code></td>
+ <td>
+ <p>A Builder for creating <code>PersistentCacheSettings</code> instance.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a></code></td>
<td>
<p>A <code>Query</code> which you can read or listen to.</p> |
|
The public api surface has changed for the subproject firebase-firestore: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
2 similar comments
|
The public api surface has changed for the subproject firebase-firestore: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-firestore: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
Coverage Report 1Affected Products
Test Logs |
Unit Test Results 158 files - 630 158 suites - 630 2m 28s ⏱️ - 33m 41s Results for commit 1501ac9. ± Comparison against base commit 5f273c7. ♻️ This comment has been updated with latest results. |
Size Report 1Affected Products
Test Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
|
The public api surface has changed for the subproject firebase-firestore: The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-firestore: The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
1 similar comment
|
The public api surface has changed for the subproject firebase-firestore: The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-firestore: The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
tom-andersen
requested changes
Apr 12, 2023
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryCacheSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
|
The public api surface has changed for the subproject firebase-firestore: The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
|
The public api surface has changed for the subproject firebase-firestore_ktx: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
wu-hui
commented
Apr 13, 2023
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/MemoryCacheSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheSettings.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java
Outdated
Show resolved
Hide resolved
tom-andersen
approved these changes
Apr 13, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.