demo code #5578
Closed
demo code #5578
Conversation
This file contains 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 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2024-01-04 15:10:36.000000000 +0000
@@ -92,6 +92,10 @@
path: "/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html"
- title: "SetOptions"
path: "/docs/reference/android/com/google/firebase/firestore/SetOptions.html"
+ - title: "SnapshotListenOptions"
+ path: "/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html"
+ - title: "SnapshotListenOptions.Builder"
+ path: "/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html"
- title: "SnapshotMetadata"
path: "/docs/reference/android/com/google/firebase/firestore/SnapshotMetadata.html"
- title: "Transaction"
@@ -114,6 +118,8 @@
path: "/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.ServerTimestampBehavior.html"
- title: "FirebaseFirestoreException.Code"
path: "/docs/reference/android/com/google/firebase/firestore/FirebaseFirestoreException.Code.html"
+ - title: "ListenSource"
+ path: "/docs/reference/android/com/google/firebase/firestore/ListenSource.html"
- title: "LoadBundleTaskProgress.TaskState"
path: "/docs/reference/android/com/google/firebase/firestore/LoadBundleTaskProgress.TaskState.html"
- title: "MetadataChanges"--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/CollectionReference.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/CollectionReference.html 2024-01-04 15:10:36.000000000 +0000
@@ -167,6 +167,12 @@
<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/ListenerRegistration.html">ListenerRegistration</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a> options,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> listener<br>)</code></div>
+ </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/ListenerRegistration.html">ListenerRegistration</a></code></td>
+ <td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> listener<br>)</code></div>
<p>Starts listening to this query with the given options, using an Activity-scoped listener.</p>
</td>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/DocumentReference.html 2024-01-04 15:12:54.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/DocumentReference.html 2024-01-04 15:10:36.000000000 +0000
@@ -78,6 +78,12 @@
<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/ListenerRegistration.html">ListenerRegistration</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a> options,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> listener<br>)</code></div>
+ </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/ListenerRegistration.html">ListenerRegistration</a></code></td>
+ <td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> listener<br>)</code></div>
<p>Starts listening to the document referenced by this <code>DocumentReference</code> with the given options using an Activity-scoped listener.</p>
</td>
@@ -223,7 +229,7 @@
<tr>
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</code></div>
<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>
</td>
</tr>
@@ -454,6 +460,10 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)"></a><a name="addSnapshotListener-com.google.firebase.firestore.SnapshotListenOptions-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>-"></a><a name="addsnapshotlistener"></a>
+ <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</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/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a> options,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> listener<br>)</pre>
+ </div>
<div class="api-item"><a name="addSnapshotListener(android.app.Activity, com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)"></a><a name="addSnapshotListener-android.app.Activity-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>-"></a><a name="addsnapshotlistener"></a>
<h3 class="api-name" id="addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</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/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> listener<br>)</pre>
@@ -1143,9 +1153,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">FirestoreKt.snapshots</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">FirestoreKt.snapshots</h3>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</pre>
<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>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FirestoreKt.html 2024-01-04 15:12:54.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FirestoreKt.html 2024-01-04 15:10:36.000000000 +0000
@@ -142,14 +142,14 @@
<tr>
<td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</code></div>
<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>
</td>
</tr>
<tr>
<td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</code></div>
<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>
</td>
</tr>
@@ -510,9 +510,9 @@
<h3 class="api-name" id="persistentCacheSettings(kotlin.Function1)">persistentCacheSettings</h3>
<pre class="api-signature no-pretty-print">public static final @<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/FirestoreKt.html#persistentCacheSettings(kotlin.Function1)">persistentCacheSettings</a>(<br> @<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-extension-function-type/index.html">ExtensionFunctionType</a> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> Function1<@<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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a>> init<br>)</pre>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">FirestoreKt.snapshots</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">FirestoreKt.snapshots</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</pre>
<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>
@@ -544,9 +544,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">FirestoreKt.snapshots</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">FirestoreKt.snapshots</h3>
+ <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</pre>
<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>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/ListenSource.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/ListenSource.html 2024-01-04 15:10:36.000000000 +0000
@@ -0,0 +1,156 @@
+<html devsite="true">
+ <head>
+ <title>ListenSource</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>ListenSource</h1>
+ <p>
+ <pre>public enum <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a></pre>
+ </p>
+ <hr>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Enum Values</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#CACHE">CACHE</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#DEFAULT">DEFAULT</a></code></td>
+ <td></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>static <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#valueOf(java.lang.String)">valueOf</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> name)</code></div>
+ <p>Returns the enum constant of this type with the specified name.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static ListenSource[]</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#values()">values</a>()</code></div>
+ <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Enum Values</h2>
+ <div class="api-item">
+ <h3 class="api-name" id="CACHE">CACHE</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#CACHE">ListenSource.CACHE</a></pre>
+ </div>
+ <div class="api-item">
+ <h3 class="api-name" id="DEFAULT">DEFAULT</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#DEFAULT">ListenSource.DEFAULT</a></pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="valueOf-java.lang.String-"></a><a name="valueof"></a>
+ <h3 class="api-name" id="valueOf(java.lang.String)">valueOf</h3>
+ <pre class="api-signature no-pretty-print">public static <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#valueOf(java.lang.String)">valueOf</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> name)</pre>
+ <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</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/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a></code></td>
+ <td>
+ <p>the enum constant with the specified name</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%">Throws</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html">java.lang.IllegalArgumentException</a> java.lang.IllegalArgumentException</code></td>
+ <td>
+ <p>if this enum type has no constant with the specified name</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="values--"></a><a name="values"></a>
+ <h3 class="api-name" id="values()">values</h3>
+ <pre class="api-signature no-pretty-print">public static ListenSource[] <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html#values()">values</a>()</pre>
+ <p>Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.</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>ListenSource[]</code></td>
+ <td>
+ <p>an array containing the constants of this enum type, in the order they're declared</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/Query.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/Query.html 2024-01-04 15:10:36.000000000 +0000
@@ -121,6 +121,12 @@
<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/ListenerRegistration.html">ListenerRegistration</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a> options,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> listener<br>)</code></div>
+ </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/ListenerRegistration.html">ListenerRegistration</a></code></td>
+ <td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> listener<br>)</code></div>
<p>Starts listening to this query with the given options, using an Activity-scoped listener.</p>
</td>
@@ -456,7 +462,7 @@
<tr>
<td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</code></div>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</code></div>
<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>
</td>
</tr>
@@ -687,6 +693,10 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)"></a><a name="addSnapshotListener-com.google.firebase.firestore.SnapshotListenOptions-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>-"></a><a name="addsnapshotlistener"></a>
+ <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</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/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a> options,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> listener<br>)</pre>
+ </div>
<div class="api-item"><a name="addSnapshotListener(android.app.Activity, com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)"></a><a name="addSnapshotListener-android.app.Activity-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>-"></a><a name="addsnapshotlistener"></a>
<h3 class="api-name" id="addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</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/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> listener<br>)</pre>
@@ -2825,9 +2835,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">FirestoreKt.snapshots</h3>
- <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges<br>)</pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">FirestoreKt.snapshots</h3>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/FirestoreKt.html">FirestoreKt</a>.<a href="/docs/reference/android/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a> receiver,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source<br>)</pre>
<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>--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html 2024-01-04 15:10:36.000000000 +0000
@@ -0,0 +1,112 @@
+<html devsite="true">
+ <head>
+ <title>SnapshotListenOptions.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>SnapshotListenOptions.Builder</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></pre>
+ </p>
+ <hr>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public constructors</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#Builder()">Builder</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>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#build()">build</a>()</code></div>
+ </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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setActivity(android.app.Activity)">setActivity</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity)</code></div>
+ </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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setExecutor(java.util.concurrent.Executor)">setExecutor</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a> executor)</code></div>
+ </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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setMetadataChanges(com.google.firebase.firestore.MetadataChanges)">setMetadataChanges</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges)</code></div>
+ </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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setSource(com.google.firebase.firestore.ListenSource)">setSource</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source)</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public constructors</h2>
+ <div class="api-item"><a name="Builder--"></a><a name="builder"></a>
+ <h3 class="api-name" id="Builder()">Builder</h3>
+ <pre class="api-signature no-pretty-print">public <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#Builder()">Builder</a>()</pre>
+ </div>
+ </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/SnapshotListenOptions.html">SnapshotListenOptions</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#build()">build</a>()</pre>
+ </div>
+ <div class="api-item"><a name="setActivity-android.app.Activity-"></a><a name="setactivity"></a>
+ <h3 class="api-name" id="setActivity(android.app.Activity)">setActivity</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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setActivity(android.app.Activity)">setActivity</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> activity)</pre>
+ </div>
+ <div class="api-item"><a name="setExecutor-java.util.concurrent.Executor-"></a><a name="setexecutor"></a>
+ <h3 class="api-name" id="setExecutor(java.util.concurrent.Executor)">setExecutor</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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setExecutor(java.util.concurrent.Executor)">setExecutor</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a> executor)</pre>
+ </div>
+ <div class="api-item"><a name="setMetadataChanges-com.google.firebase.firestore.MetadataChanges-"></a><a name="setmetadatachanges"></a>
+ <h3 class="api-name" id="setMetadataChanges(com.google.firebase.firestore.MetadataChanges)">setMetadataChanges</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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setMetadataChanges(com.google.firebase.firestore.MetadataChanges)">setMetadataChanges</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> metadataChanges)</pre>
+ </div>
+ <div class="api-item"><a name="setSource-com.google.firebase.firestore.ListenSource-"></a><a name="setsource"></a>
+ <h3 class="api-name" id="setSource(com.google.firebase.firestore.ListenSource)">setSource</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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setSource(com.google.firebase.firestore.ListenSource)">setSource</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> source)</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/SnapshotListenOptions.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/SnapshotListenOptions.html 2024-01-04 15:10:36.000000000 +0000
@@ -0,0 +1,181 @@
+<html devsite="true">
+ <head>
+ <title>SnapshotListenOptions</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>SnapshotListenOptions</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></pre>
+ </p>
+ <hr>
+ <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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</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 fields</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>final <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#activity()">activity</a></code></div>
+ <p>The activity to scope the listener to.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>final <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#executor()">executor</a></code></div>
+ <p>The executor to use to call the listener.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>final <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#metadataChanges()">metadataChanges</a></code></div>
+ <p>Indicates whether metadata-only changes should trigger snapshot events.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>final <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#source()">source</a></code></div>
+ <p>Indicates the source that we listen to.</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/SnapshotListenOptions.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="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getActivity()">getActivity</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getExecutor()">getExecutor</a>()</code></div>
+ </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/MetadataChanges.html">MetadataChanges</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getMetadataChanges()">getMetadataChanges</a>()</code></div>
+ </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/ListenSource.html">ListenSource</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getSource()">getSource</a>()</code></div>
+ </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/SnapshotListenOptions.html#toString()">toString</a>()</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getActivity()"></a><a name="setActivity()"></a><a name="getActivity--"></a><a name="setActivity--"></a>
+ <h3 class="api-name" id="activity()">activity</h3>
+ <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#activity()">activity</a></pre>
+ <p>The activity to scope the listener to.</p>
+ </div>
+ <div class="api-item"><a name="getExecutor()"></a><a name="setExecutor()"></a><a name="getExecutor--"></a><a name="setExecutor--"></a>
+ <h3 class="api-name" id="executor()">executor</h3>
+ <pre class="api-signature no-pretty-print">public final <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#executor()">executor</a></pre>
+ <p>The executor to use to call the listener.</p>
+ </div>
+ <div class="api-item"><a name="getMetadataChanges()"></a><a name="setMetadataChanges()"></a><a name="getMetadataChanges--"></a><a name="setMetadataChanges--"></a>
+ <h3 class="api-name" id="metadataChanges()">metadataChanges</h3>
+ <pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#metadataChanges()">metadataChanges</a></pre>
+ <p>Indicates whether metadata-only changes should trigger snapshot events.</p>
+ </div>
+ <div class="api-item"><a name="getSource()"></a><a name="setSource()"></a><a name="getSource--"></a><a name="setSource--"></a>
+ <h3 class="api-name" id="source()">source</h3>
+ <pre class="api-signature no-pretty-print">public final <a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#source()">source</a></pre>
+ <p>Indicates the source that we listen to.</p>
+ </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/SnapshotListenOptions.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="getActivity--"></a><a name="getactivity"></a>
+ <h3 class="api-name" id="getActivity()">getActivity</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="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getActivity()">getActivity</a>()</pre>
+ </div>
+ <div class="api-item"><a name="getExecutor--"></a><a name="getexecutor"></a>
+ <h3 class="api-name" id="getExecutor()">getExecutor</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="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getExecutor()">getExecutor</a>()</pre>
+ </div>
+ <div class="api-item"><a name="getMetadataChanges--"></a><a name="getmetadatachanges"></a>
+ <h3 class="api-name" id="getMetadataChanges()">getMetadataChanges</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/MetadataChanges.html">MetadataChanges</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getMetadataChanges()">getMetadataChanges</a>()</pre>
+ </div>
+ <div class="api-item"><a name="getSource--"></a><a name="getsource"></a>
+ <h3 class="api-name" id="getSource()">getSource</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/ListenSource.html">ListenSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html#getSource()">getSource</a>()</pre>
+ </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/SnapshotListenOptions.html#toString()">toString</a>()</pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2024-01-04 15:10:36.000000000 +0000
@@ -312,6 +312,14 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/SnapshotMetadata.html">SnapshotMetadata</a></code></td>
<td>
<p>Metadata about a snapshot, describing the state of the snapshot.</p>
@@ -377,6 +385,10 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/ListenSource.html">ListenSource</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/LoadBundleTaskProgress.TaskState.html">LoadBundleTaskProgress.TaskState</a></code></td>
<td>
<p>Represents the state of bundle loading tasks.</p>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2024-01-04 15:10:36.000000000 +0000
@@ -90,6 +90,10 @@
path: "/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html"
- title: "SetOptions"
path: "/docs/reference/kotlin/com/google/firebase/firestore/SetOptions.html"
+ - title: "SnapshotListenOptions"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html"
+ - title: "SnapshotListenOptions.Builder"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html"
- title: "SnapshotMetadata"
path: "/docs/reference/kotlin/com/google/firebase/firestore/SnapshotMetadata.html"
- title: "Transaction"
@@ -112,6 +116,8 @@
path: "/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.ServerTimestampBehavior.html"
- title: "FirebaseFirestoreException.Code"
path: "/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestoreException.Code.html"
+ - title: "ListenSource"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html"
- title: "LoadBundleTaskProgress.TaskState"
path: "/docs/reference/kotlin/com/google/firebase/firestore/LoadBundleTaskProgress.TaskState.html"
- title: "MetadataChanges"--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/CollectionReference.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/CollectionReference.html 2024-01-04 15:10:36.000000000 +0000
@@ -136,6 +136,12 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>!><br>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
+ <td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>,<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>!><br>)</code></div>
<p>Starts listening to this query with the given options, using an Activity-scoped listener.</p>
</td>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/DocumentReference.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/DocumentReference.html 2024-01-04 15:10:36.000000000 +0000
@@ -57,6 +57,12 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>!><br>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
+ <td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>,<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>!><br>)</code></div>
<p>Starts listening to the document referenced by this <code>DocumentReference</code> with the given options using an Activity-scoped listener.</p>
</td>
@@ -216,7 +222,7 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a><br>)</code></div>
<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>
</td>
</tr>
@@ -440,6 +446,10 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)"></a><a name="addSnapshotListener-com.google.firebase.firestore.SnapshotListenOptions-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>-"></a><a name="addsnapshotlistener"></a>
+ <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>!><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
+ </div>
<div class="api-item"><a name="addSnapshotListener(android.app.Activity, com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)"></a><a name="addSnapshotListener-android.app.Activity-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>-"></a><a name="addsnapshotlistener"></a>
<h3 class="api-name" id="addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.DocumentSnapshot>)">addSnapshotListener</a>(<br> activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>,<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>!><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
@@ -1131,9 +1141,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE,<br> source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a> = ListenSource.DEFAULT<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></pre>
<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>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/ListenSource.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/ListenSource.html 2024-01-04 15:10:36.000000000 +0000
@@ -0,0 +1,156 @@
+<html devsite="true">
+ <head>
+ <title>ListenSource</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>ListenSource</h1>
+ <p>
+ <pre>enum <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a></pre>
+ </p>
+ <hr>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Enum Values</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#CACHE">CACHE</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#DEFAULT">DEFAULT</a></code></td>
+ <td></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>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#valueOf(java.lang.String)">valueOf</a>(name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!)</code></div>
+ <p>Returns the enum constant of this type with the specified name.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#values()">values</a>()</code></div>
+ <p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Enum Values</h2>
+ <div class="api-item">
+ <h3 class="api-name" id="CACHE">CACHE</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#CACHE">ListenSource.CACHE</a>: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a></pre>
+ </div>
+ <div class="api-item">
+ <h3 class="api-name" id="DEFAULT">DEFAULT</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#DEFAULT">ListenSource.DEFAULT</a>: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a></pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="valueOf-java.lang.String-"></a><a name="valueof"></a>
+ <h3 class="api-name" id="valueOf(java.lang.String)">valueOf</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#valueOf(java.lang.String)">valueOf</a>(name: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!</pre>
+ <p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</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/ListenSource.html">ListenSource</a>!</code></td>
+ <td>
+ <p>the enum constant with the specified name</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%">Throws</th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>java.lang.IllegalArgumentException: <a href="https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html">java.lang.IllegalArgumentException</a></code></td>
+ <td>
+ <p>if this enum type has no constant with the specified name</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="values--"></a><a name="values"></a>
+ <h3 class="api-name" id="values()">values</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html#values()">values</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!>!</pre>
+ <p>Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.</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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!>!</code></td>
+ <td>
+ <p>an array containing the constants of this enum type, in the order they're declared</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/Query.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/Query.html 2024-01-04 15:10:36.000000000 +0000
@@ -100,6 +100,12 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>!><br>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
+ <td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>,<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>!><br>)</code></div>
<p>Starts listening to this query with the given options, using an Activity-scoped listener.</p>
</td>
@@ -449,7 +455,7 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>, source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>)</code></div>
<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>
</td>
</tr>
@@ -673,6 +679,10 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)"></a><a name="addSnapshotListener-com.google.firebase.firestore.SnapshotListenOptions-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>-"></a><a name="addsnapshotlistener"></a>
+ <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#addSnapshotListener(com.google.firebase.firestore.SnapshotListenOptions,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>!><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
+ </div>
<div class="api-item"><a name="addSnapshotListener(android.app.Activity, com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)"></a><a name="addSnapshotListener-android.app.Activity-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>-"></a><a name="addsnapshotlistener"></a>
<h3 class="api-name" id="addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#addSnapshotListener(android.app.Activity,com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>)">addSnapshotListener</a>(<br> activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>,<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>!><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
@@ -2813,9 +2823,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE,<br> source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a> = ListenSource.DEFAULT<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></pre>
<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>--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html 2024-01-04 15:10:36.000000000 +0000
@@ -0,0 +1,112 @@
+<html devsite="true">
+ <head>
+ <title>SnapshotListenOptions.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>SnapshotListenOptions.Builder</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></pre>
+ </p>
+ <hr>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public constructors</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#Builder()">Builder</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 functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#build()">build</a>()</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setActivity(android.app.Activity)">setActivity</a>(activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setExecutor(java.util.concurrent.Executor)">setExecutor</a>(executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setMetadataChanges(com.google.firebase.firestore.MetadataChanges)">setMetadataChanges</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>)</code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setSource(com.google.firebase.firestore.ListenSource)">setSource</a>(source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>)</code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public constructors</h2>
+ <div class="api-item"><a name="Builder--"></a><a name="builder"></a>
+ <h3 class="api-name" id="Builder()">Builder</h3>
+ <pre class="api-signature no-pretty-print"><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#Builder()">Builder</a>()</pre>
+ </div>
+ </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/SnapshotListenOptions.Builder.html#build()">build</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></pre>
+ </div>
+ <div class="api-item"><a name="setActivity-android.app.Activity-"></a><a name="setactivity"></a>
+ <h3 class="api-name" id="setActivity(android.app.Activity)">setActivity</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setActivity(android.app.Activity)">setActivity</a>(activity: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></pre>
+ </div>
+ <div class="api-item"><a name="setExecutor-java.util.concurrent.Executor-"></a><a name="setexecutor"></a>
+ <h3 class="api-name" id="setExecutor(java.util.concurrent.Executor)">setExecutor</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setExecutor(java.util.concurrent.Executor)">setExecutor</a>(executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></pre>
+ </div>
+ <div class="api-item"><a name="setMetadataChanges-com.google.firebase.firestore.MetadataChanges-"></a><a name="setmetadatachanges"></a>
+ <h3 class="api-name" id="setMetadataChanges(com.google.firebase.firestore.MetadataChanges)">setMetadataChanges</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setMetadataChanges(com.google.firebase.firestore.MetadataChanges)">setMetadataChanges</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></pre>
+ </div>
+ <div class="api-item"><a name="setSource-com.google.firebase.firestore.ListenSource-"></a><a name="setsource"></a>
+ <h3 class="api-name" id="setSource(com.google.firebase.firestore.ListenSource)">setSource</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html#setSource(com.google.firebase.firestore.ListenSource)">setSource</a>(source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></pre>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html 2024-01-04 15:10:36.000000000 +0000
@@ -0,0 +1,141 @@
+<html devsite="true">
+ <head>
+ <title>SnapshotListenOptions</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>SnapshotListenOptions</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></pre>
+ </p>
+ <hr>
+ <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/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</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 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/SnapshotListenOptions.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/-string/index.html">String</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.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://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#activity()">activity</a></code></div>
+ <p>The activity to scope the listener to.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#executor()">executor</a></code></div>
+ <p>The executor to use to call the listener.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#metadataChanges()">metadataChanges</a></code></div>
+ <p>Indicates whether metadata-only changes should trigger snapshot events.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#source()">source</a></code></div>
+ <p>Indicates the source that we listen to.</p>
+ </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/SnapshotListenOptions.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="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/SnapshotListenOptions.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="getActivity()"></a><a name="setActivity()"></a><a name="getActivity--"></a><a name="setActivity--"></a>
+ <h3 class="api-name" id="activity()">activity</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#activity()">activity</a>: <a href="https://developer.android.com/reference/kotlin/android/app/Activity.html">Activity</a>!</pre>
+ <p>The activity to scope the listener to.</p>
+ </div>
+ <div class="api-item"><a name="getExecutor()"></a><a name="setExecutor()"></a><a name="getExecutor--"></a><a name="setExecutor--"></a>
+ <h3 class="api-name" id="executor()">executor</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#executor()">executor</a>: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a>!</pre>
+ <p>The executor to use to call the listener.</p>
+ </div>
+ <div class="api-item"><a name="getMetadataChanges()"></a><a name="setMetadataChanges()"></a><a name="getMetadataChanges--"></a><a name="setMetadataChanges--"></a>
+ <h3 class="api-name" id="metadataChanges()">metadataChanges</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#metadataChanges()">metadataChanges</a>: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>!</pre>
+ <p>Indicates whether metadata-only changes should trigger snapshot events.</p>
+ </div>
+ <div class="api-item"><a name="getSource()"></a><a name="setSource()"></a><a name="getSource--"></a><a name="setSource--"></a>
+ <h3 class="api-name" id="source()">source</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html#source()">source</a>: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>!</pre>
+ <p>Indicates the source that we listen to.</p>
+ </div>
+ </div>
+ </body>
+</html>
+--- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2024-01-04 15:12:53.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2024-01-04 15:10:36.000000000 +0000
@@ -261,6 +261,14 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.html">SnapshotListenOptions</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotListenOptions.Builder.html">SnapshotListenOptions.Builder</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SnapshotMetadata.html">SnapshotMetadata</a></code></td>
<td>
<p>Metadata about a snapshot, describing the state of the snapshot.</p>
@@ -390,6 +398,10 @@
</td>
</tr>
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a></code></td>
+ <td></td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/LoadBundleTaskProgress.TaskState.html">LoadBundleTaskProgress.TaskState</a></code></td>
<td>
<p>Represents the state of bundle loading tasks.</p>
@@ -532,14 +544,14 @@
<tr>
<td><code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>,<br> source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a><br>)</code></div>
<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>
</td>
</tr>
<tr>
<td><code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></code></td>
<td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>)</code></div>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a>, source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a>)</code></div>
<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>
</td>
</tr>
@@ -910,9 +922,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.DocumentReference-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentReference.html">DocumentReference</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.DocumentReference).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE,<br> source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a> = ListenSource.DEFAULT<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/DocumentSnapshot.html">DocumentSnapshot</a>></pre>
<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>
@@ -944,9 +956,9 @@
</table>
</div>
</div>
- <div class="api-item"><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></pre>
+ <div class="api-item"><a name="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges, com.google.firebase.firestore.ListenSource)"></a><a name="-com.google.firebase.firestore.Query-.snapshots-com.google.firebase.firestore.MetadataChanges-com.google.firebase.firestore.ListenSource-"></a><a name="snapshots"></a>
+ <h3 class="api-name" id="(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>.<a href="/docs/reference/kotlin/com/google/firebase/firestore/package-summary.html#(com.google.firebase.firestore.Query).snapshots(com.google.firebase.firestore.MetadataChanges,com.google.firebase.firestore.ListenSource)">snapshots</a>(<br> metadataChanges: <a href="/docs/reference/kotlin/com/google/firebase/firestore/MetadataChanges.html">MetadataChanges</a> = MetadataChanges.EXCLUDE,<br> source: <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenSource.html">ListenSource</a> = ListenSource.DEFAULT<br>): <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html">QuerySnapshot</a>></pre>
<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> |
Generated by 🚫 Danger |
|
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 ProductsNo changes between base commit (a16c647) and merge commit (73087ca).Test Logs |
|
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. |
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: 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: 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. |
|
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. |
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.