firebase
Hide realtime pipeline
Firebase AI Mock Responses Check :warning:
A newer major version of the mock responses for Firebase AI unit tests is available. update_responses.sh should be updated to clone the latest version of the responses: v14.9
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
| 1 Warning | |
|---|---|
| :warning: | Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.) |
Generated by :no_entry_sign: Danger
Javadoc Changes:
--- /home/runner/diff/original/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2025-10-20 17:40:26.262824684 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2025-10-20 17:36:42.375194741 +0000
@@ -106,14 +106,10 @@
path: "/docs/reference/android/com/google/firebase/firestore/QueryDocumentSnapshot.html"
- title: "QuerySnapshot"
path: "/docs/reference/android/com/google/firebase/firestore/QuerySnapshot.html"
- - title: "RealtimePipeline"
- path: "/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html"
- title: "RealtimePipelineOptions"
path: "/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html"
- title: "RealtimePipelineSnapshot"
path: "/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html"
- - title: "RealtimePipelineSource"
- path: "/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html"
- title: "SetOptions"
path: "/docs/reference/android/com/google/firebase/firestore/SetOptions.html"
- title: "SnapshotListenOptions"
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestore.html 2025-10-20 17:40:26.263421146 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/FirebaseFirestore.html 2025-10-20 17:36:42.375841563 +0000
@@ -202,13 +202,6 @@
</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/RealtimePipelineSource.html">RealtimePipelineSource</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#realtimePipeline()">realtimePipeline</a>()</code></div>
- <p>Build a new RealtimePipeline from this Firestore instance.</p>
- </td>
- </tr>
- <tr>
<td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Void.html">Void</a>></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#runBatch(com.google.firebase.firestore.WriteBatch.Function)">runBatch</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/WriteBatch.Function.html">WriteBatch.Function</a> batchFunction)</code></div>
@@ -993,32 +986,6 @@
</td>
</tr>
</tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="realtimePipeline--"></a><a name="realtimepipeline"></a>
- <h3 class="api-name" id="realtimePipeline()">realtimePipeline</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/RealtimePipelineSource.html">RealtimePipelineSource</a> <a href="/docs/reference/android/com/google/firebase/firestore/FirebaseFirestore.html#realtimePipeline()">realtimePipeline</a>()</pre>
- <p>Build a new RealtimePipeline from this Firestore instance. NOTE: RealtimePipeline utilizes the Firestore realtime backend and SDK cache to provide final results, this is the equivalent to classic Firestore <code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html">Query</a></code>, but with more features supported. However, its feature set is only a subset of <code>Pipeline</code>. If you need features unavailable in <code>RealtimePipeline</code> and realtime or SDK cache access are not a must, use <code>pipeline()</code> instead.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</a></code></td>
- <td>
- <p><code>RealtimePipelineSource</code> for this Firestore instance.</p>
- </td>
- </tr>
- </tbody>
</table>
</div>
</div>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/RealtimePipeline.html 2025-10-20 17:40:26.265549533 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/RealtimePipeline.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,589 +0,0 @@
-<html devsite="true">
- <head>
- <title>RealtimePipeline</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>RealtimePipeline</h1>
- <p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</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 methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final @<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/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.EventListener)">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/EventListener.html">EventListener</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<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/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.EventListener)">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/java/util/concurrent/Executor.html">Executor</a> executor,<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="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<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/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">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/RealtimePipelineOptions.html">RealtimePipelineOptions</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="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<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/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">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/java/util/concurrent/Executor.html">Executor</a> executor,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</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="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>boolean</code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#equals(kotlin.Any)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</code></div>
- </td>
- </tr>
- <tr>
- <td><code>int</code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#hashCode()">hashCode</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#limit(kotlin.Int)">limit</a>(int limit)</code></div>
- <p>Limits the maximum number of documents returned by previous stages to <code>limit</code>.</p>
- </td>
- </tr>
- <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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#snapshots()">snapshots</a>()</code></div>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</p>
- </td>
- </tr>
- <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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#snapshots(com.google.firebase.firestore.RealtimePipelineOptions)">snapshots</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a> options)</code></div>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#sort(com.google.firebase.firestore.pipeline.Ordering,kotlin.Array)">sort</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a> order, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a> additionalOrders)</code></div>
- <p>Sorts the documents from previous stages based on one or more <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> criteria.</p>
- </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/lang/String.html">String</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#toString()">toString</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a> condition)</code></div>
- <p>Filters the documents from previous stages to only include those matching the specified <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="addSnapshotListener-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.EventListener)">addSnapshotListener</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="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.EventListener)">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/EventListener.html">EventListener</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/EventListener.html">EventListener</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener</code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="addSnapshotListener(java.util.concurrent.Executor, com.google.firebase.firestore.EventListener)"></a><a name="addSnapshotListener-java.util.concurrent.Executor-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.EventListener)">addSnapshotListener</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="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.EventListener)">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/java/util/concurrent/Executor.html">Executor</a> executor,<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="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a> executor</code></td>
- <td>
- <p>The executor to use for the listener.</p>
- </td>
- </tr>
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener</code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions, com.google.firebase.firestore.EventListener)"></a><a name="addSnapshotListener-com.google.firebase.firestore.RealtimePipelineOptions-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</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="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">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/RealtimePipelineOptions.html">RealtimePipelineOptions</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="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/RealtimePipelineOptions.html">RealtimePipelineOptions</a> options</code></td>
- <td>
- <p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code> to use for this listen.</p>
- </td>
- </tr>
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener</code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="addSnapshotListener(java.util.concurrent.Executor, com.google.firebase.firestore.RealtimePipelineOptions, com.google.firebase.firestore.EventListener)"></a><a name="addSnapshotListener-java.util.concurrent.Executor-com.google.firebase.firestore.RealtimePipelineOptions-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</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="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">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/java/util/concurrent/Executor.html">Executor</a> executor,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</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="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener<br>)</pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a> executor</code></td>
- <td>
- <p>The executor to use for the listener.</p>
- </td>
- </tr>
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a> options</code></td>
- <td>
- <p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code> to use for this listen.</p>
- </td>
- </tr>
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/EventListener.html">EventListener</a><@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> listener</code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="equals-kotlin.Any-"></a><a name="equals"></a>
- <h3 class="api-name" id="equals(kotlin.Any)">equals</h3>
- <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#equals(kotlin.Any)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</pre>
- </div>
- <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
- <h3 class="api-name" id="hashCode()">hashCode</h3>
- <pre class="api-signature no-pretty-print">public int <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#hashCode()">hashCode</a>()</pre>
- </div>
- <div class="api-item"><a name="limit-kotlin.Int-"></a><a name="limit"></a>
- <h3 class="api-name" id="limit(kotlin.Int)">limit</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#limit(kotlin.Int)">limit</a>(int limit)</pre>
- <p>Limits the maximum number of documents returned by previous stages to <code>limit</code>.</p>
- <p>This stage is particularly useful when you want to retrieve a controlled subset of data from a potentially large result set. It's often used for:</p>
- <ul>
- <li>
- <p><b>Pagination:</b> In combination with <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</a></code> to retrieve specific pages of results.</p>
- </li>
- <li>
- <p><b>Limiting Data Retrieval:</b> To prevent excessive data transfer and improve performance, especially when dealing with large collections.</p>
- </li>
- </ul>
- <p>Example:</p>
- <pre class="prettyprint">// Limit the results to the top 10 highest-rated books<br>firestore.pipeline().collection("books")<br> .sort(field("rating").descending())<br> .limit(10);</pre>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>int limit</code></td>
- <td>
- <p>The maximum number of documents to return.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with this stage appended to the stage list.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="snapshots--"></a><a name="snapshots"></a>
- <h3 class="api-name" id="snapshots()">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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#snapshots()">snapshots</a>()</pre>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>A <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code> of <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> that emits new snapshots on every change.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="snapshots-com.google.firebase.firestore.RealtimePipelineOptions-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="snapshots(com.google.firebase.firestore.RealtimePipelineOptions)">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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#snapshots(com.google.firebase.firestore.RealtimePipelineOptions)">snapshots</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a> options)</pre>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/RealtimePipelineOptions.html">RealtimePipelineOptions</a> options</code></td>
- <td>
- <p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code> to use for this listen.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>A <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code> of <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> that emits new snapshots on every change.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="sort(com.google.firebase.firestore.pipeline.Ordering, kotlin.Array)"></a><a name="sort-com.google.firebase.firestore.pipeline.Ordering-kotlin.Array-"></a><a name="sort"></a>
- <h3 class="api-name" id="sort(com.google.firebase.firestore.pipeline.Ordering,kotlin.Array)">sort</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#sort(com.google.firebase.firestore.pipeline.Ordering,kotlin.Array)">sort</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a> order, @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a> additionalOrders)</pre>
- <p>Sorts the documents from previous stages based on one or more <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> criteria.</p>
- <p>This stage allows you to order the results of your pipeline. You can specify multiple <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> instances to sort by multiple fields in ascending or descending order. If documents have the same value for a field used for sorting, the next specified ordering will be used. If all orderings result in equal comparison, the documents are considered equal and the order is unspecified.</p>
- <p>Example:</p>
- <pre class="prettyprint">// Sort books by rating in descending order, and then by title in ascending order for books with the same rating<br>firestore.pipeline().collection("books")<br> .sort(<br> Ordering.of("rating").descending(),<br> Ordering.of("title") // Ascending order is the default<br> );</pre>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/pipeline/Ordering.html">Ordering</a> order</code></td>
- <td>
- <p>The first <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> instance specifying the sorting criteria.</p>
- </td>
- </tr>
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a> additionalOrders</code></td>
- <td>
- <p>Optional additional <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> instances specifying the sorting criteria.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with this stage appended to the stage list.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </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/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#toString()">toString</a>()</pre>
- </div>
- <div class="api-item"><a name="where-com.google.firebase.firestore.pipeline.BooleanExpression-"></a><a name="where"></a>
- <h3 class="api-name" id="where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html#where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a> condition)</pre>
- <p>Filters the documents from previous stages to only include those matching the specified <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code>.</p>
- <p>This stage allows you to apply conditions to the data, similar to a "WHERE" clause in SQL.</p>
- <p>You can filter documents based on their field values, using implementations of <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code>, typically including but not limited to:</p>
- <ul>
- <li>
- <p>field comparators: Expr.eq, Expr.lt (less than), Expr.gt (greater than), etc.</p>
- </li>
- <li>
- <p>logical operators: Expr.and, Expr.or, Expr.not, etc.</p>
- </li>
- <li>
- <p>advanced functions: Expr.arrayContains, Expr.eqAnyetc.</p>
- </li>
- </ul>
- <p>Example:</p>
- <pre class="prettyprint">firestore.pipeline().collection("books")<br> .where(<br> and(<br> gt("rating", 4.0), // Filter for ratings greater than 4.0<br> field("genre").eq("Science Fiction") // Equivalent to eq("genre", "Science Fiction")<br> )<br> );</pre>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/pipeline/BooleanExpression.html">BooleanExpression</a> condition</code></td>
- <td>
- <p>The <code><a href="/docs/reference/android/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code> to apply.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with this stage appended to the stage list.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </body>
-</html>
-
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/RealtimePipelineSource.html 2025-10-20 17:40:26.266644216 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/RealtimePipelineSource.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,293 +0,0 @@
-<html devsite="true">
- <head>
- <title>RealtimePipelineSource</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/android/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>RealtimePipelineSource</h1>
- <p>
- <pre>public final class <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</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 methods</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collection(kotlin.String)">collection</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> path)</code></div>
- <p>Set the pipeline's source to the collection specified by the given path.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collection(com.google.firebase.firestore.CollectionReference)">collection</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a> ref)</code></div>
- <p>Set the pipeline's source to the collection specified by the given <code><a href="/docs/reference/android/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collectionGroup(kotlin.String)">collectionGroup</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> collectionId)</code></div>
- <p>Set the pipeline's source to the collection group with the given id.</p>
- </td>
- </tr>
- <tr>
- <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">convertFrom</a>(@<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> query)</code></div>
- <p>Convert the given Query into an equivalent Pipeline.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public methods</h2>
- <div class="api-item"><a name="collection-kotlin.String-"></a><a name="collection"></a>
- <h3 class="api-name" id="collection(kotlin.String)">collection</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collection(kotlin.String)">collection</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> path)</pre>
- <p>Set the pipeline's source to the collection specified by the given path.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> path</code></td>
- <td>
- <p>A path to a collection that will be the source of this pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with documents from target collection.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="collection-com.google.firebase.firestore.CollectionReference-"></a><a name="collection"></a>
- <h3 class="api-name" id="collection(com.google.firebase.firestore.CollectionReference)">collection</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collection(com.google.firebase.firestore.CollectionReference)">collection</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a> ref)</pre>
- <p>Set the pipeline's source to the collection specified by the given <code><a href="/docs/reference/android/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/CollectionReference.html">CollectionReference</a> ref</code></td>
- <td>
- <p>A <code><a href="/docs/reference/android/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code> for a collection that will be the source of this pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with documents from target collection.</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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>Thrown if the <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collection(com.google.firebase.firestore.CollectionReference)">ref</a></code> provided targets a different project or database than the pipeline.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="collectionGroup-kotlin.String-"></a><a name="collectiongroup"></a>
- <h3 class="api-name" id="collectionGroup(kotlin.String)">collectionGroup</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#collectionGroup(kotlin.String)">collectionGroup</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> collectionId)</pre>
- <p>Set the pipeline's source to the collection group with the given id.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a> collectionId</code></td>
- <td>
- <p>The id of a collection group that will be the source of this pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with documents from target collection group.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="convertFrom-com.google.firebase.firestore.Query-"></a><a name="convertfrom"></a>
- <h3 class="api-name" id="convertFrom(com.google.firebase.firestore.Query)">convertFrom</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="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">convertFrom</a>(@<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> query)</pre>
- <p>Convert the given Query into an equivalent Pipeline.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</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/Query.html">Query</a> query</code></td>
- <td>
- <p>A Query to be converted into a Pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/android/com/google/firebase/firestore/Pipeline.html">Pipeline</a></code> object that is equivalent to <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">query</a></code></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://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a> kotlin.IllegalArgumentException</code></td>
- <td>
- <p>Thrown if the <code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">query</a></code> provided targets a different project or database than the pipeline.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </body>
-</html>
-
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2025-10-20 17:40:26.263688310 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2025-10-20 17:36:42.376587552 +0000
@@ -346,10 +346,6 @@
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td></td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code></td>
<td>
<p>An options object that configures the behavior of <code>snapshots()</code> calls.</p>
@@ -362,10 +358,6 @@
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/android/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</a></code></td>
- <td></td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/SetOptions.html">SetOptions</a></code></td>
<td>
<p>An options object that configures the behavior of <code>set()</code> calls.</p>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2025-10-20 17:40:26.276892697 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2025-10-20 17:36:42.389995474 +0000
@@ -104,14 +104,10 @@
path: "/docs/reference/kotlin/com/google/firebase/firestore/QueryDocumentSnapshot.html"
- title: "QuerySnapshot"
path: "/docs/reference/kotlin/com/google/firebase/firestore/QuerySnapshot.html"
- - title: "RealtimePipeline"
- path: "/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html"
- title: "RealtimePipelineOptions"
path: "/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html"
- title: "RealtimePipelineSnapshot"
path: "/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html"
- - title: "RealtimePipelineSource"
- path: "/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html"
- title: "SetOptions"
path: "/docs/reference/kotlin/com/google/firebase/firestore/SetOptions.html"
- title: "SnapshotListenOptions"
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestore.html 2025-10-20 17:40:26.277166121 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/FirebaseFirestore.html 2025-10-20 17:36:42.390590345 +0000
@@ -174,13 +174,6 @@
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#realtimePipeline()">realtimePipeline</a>()</code></div>
- <p>Build a new RealtimePipeline from this Firestore instance.</p>
- </td>
- </tr>
- <tr>
<td><code><a href="https://developers.google.com/android/reference/com/google/android/gms/tasks/Task.html">Task</a><<a href="https://developer.android.com/reference/kotlin/java/lang/Void.html">Void</a>!></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#runBatch(com.google.firebase.firestore.WriteBatch.Function)">runBatch</a>(batchFunction: <a href="/docs/reference/kotlin/com/google/firebase/firestore/WriteBatch.Function.html">WriteBatch.Function</a>)</code></div>
@@ -952,32 +945,6 @@
</td>
</tr>
</tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="realtimePipeline--"></a><a name="realtimepipeline"></a>
- <h3 class="api-name" id="realtimePipeline()">realtimePipeline</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/FirebaseFirestore.html#realtimePipeline()">realtimePipeline</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</a></pre>
- <p>Build a new RealtimePipeline from this Firestore instance. NOTE: RealtimePipeline utilizes the Firestore realtime backend and SDK cache to provide final results, this is the equivalent to classic Firestore <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a></code>, but with more features supported. However, its feature set is only a subset of <code>Pipeline</code>. If you need features unavailable in <code>RealtimePipeline</code> and realtime or SDK cache access are not a must, use <code>pipeline()</code> instead.</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/RealtimePipelineSource.html">RealtimePipelineSource</a></code></td>
- <td>
- <p><code>RealtimePipelineSource</code> for this Firestore instance.</p>
- </td>
- </tr>
- </tbody>
</table>
</div>
</div>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/RealtimePipeline.html 2025-10-20 17:40:26.278596526 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/RealtimePipeline.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,589 +0,0 @@
-<html devsite="true">
- <head>
- <title>RealtimePipeline</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/kotlin/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>RealtimePipeline</h1>
- <p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</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 functions</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <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/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </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/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(<br> executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>><br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </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/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>><br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </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/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(<br> executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a>,<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>><br>)</code></div>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>open operator <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/RealtimePipeline.html#equals(kotlin.Any)">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?)</code></div>
- </td>
- </tr>
- <tr>
- <td><code>open <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#hashCode()">hashCode</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#limit(kotlin.Int)">limit</a>(limit: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>)</code></div>
- <p>Limits the maximum number of documents returned by previous stages to <code>limit</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#snapshots()">snapshots</a>()</code></div>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#snapshots(com.google.firebase.firestore.RealtimePipelineOptions)">snapshots</a>(options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a>)</code></div>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#sort(com.google.firebase.firestore.pipeline.Ordering,kotlin.Array)">sort</a>(order: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a>, vararg additionalOrders: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a>)</code></div>
- <p>Sorts the documents from previous stages based on one or more <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> criteria.</p>
- </td>
- </tr>
- <tr>
- <td><code>open <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/RealtimePipeline.html#toString()">toString</a>()</code></div>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</a>(condition: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a>)</code></div>
- <p>Filters the documents from previous stages to only include those matching the specified <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="addSnapshotListener-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.EventListener)">addSnapshotListener</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="addSnapshotListener(java.util.concurrent.Executor, com.google.firebase.firestore.EventListener)"></a><a name="addSnapshotListener-java.util.concurrent.Executor-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.EventListener)">addSnapshotListener</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(<br> executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a></code></td>
- <td>
- <p>The executor to use for the listener.</p>
- </td>
- </tr>
- <tr>
- <td><code>listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions, com.google.firebase.firestore.EventListener)"></a><a name="addSnapshotListener-com.google.firebase.firestore.RealtimePipelineOptions-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code></td>
- <td>
- <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code> to use for this listen.</p>
- </td>
- </tr>
- <tr>
- <td><code>listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="addSnapshotListener(java.util.concurrent.Executor, com.google.firebase.firestore.RealtimePipelineOptions, com.google.firebase.firestore.EventListener)"></a><a name="addSnapshotListener-java.util.concurrent.Executor-com.google.firebase.firestore.RealtimePipelineOptions-com.google.firebase.firestore.EventListener-"></a><a name="addsnapshotlistener"></a>
- <h3 class="api-name" id="addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#addSnapshotListener(java.util.concurrent.Executor,com.google.firebase.firestore.RealtimePipelineOptions,com.google.firebase.firestore.EventListener)">addSnapshotListener</a>(<br> executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a>,<br> options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></pre>
- <p>Starts listening to this pipeline using an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>executor: <a href="https://developer.android.com/reference/kotlin/java/util/concurrent/Executor.html">Executor</a></code></td>
- <td>
- <p>The executor to use for the listener.</p>
- </td>
- </tr>
- <tr>
- <td><code>options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code></td>
- <td>
- <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code> to use for this listen.</p>
- </td>
- </tr>
- <tr>
- <td><code>listener: <a href="/docs/reference/kotlin/com/google/firebase/firestore/EventListener.html">EventListener</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>The event listener to receive the results.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/ListenerRegistration.html">ListenerRegistration</a></code> that can be used to stop listening.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="equals-kotlin.Any-"></a><a name="equals"></a>
- <h3 class="api-name" id="equals(kotlin.Any)">equals</h3>
- <pre class="api-signature no-pretty-print">open operator fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#equals(kotlin.Any)">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
- </div>
- <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
- <h3 class="api-name" id="hashCode()">hashCode</h3>
- <pre class="api-signature no-pretty-print">open fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#hashCode()">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
- </div>
- <div class="api-item"><a name="limit-kotlin.Int-"></a><a name="limit"></a>
- <h3 class="api-name" id="limit(kotlin.Int)">limit</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#limit(kotlin.Int)">limit</a>(limit: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Limits the maximum number of documents returned by previous stages to <code>limit</code>.</p>
- <p>This stage is particularly useful when you want to retrieve a controlled subset of data from a potentially large result set. It's often used for:</p>
- <ul>
- <li>
- <p><b>Pagination:</b> In combination with <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</a></code> to retrieve specific pages of results.</p>
- </li>
- <li>
- <p><b>Limiting Data Retrieval:</b> To prevent excessive data transfer and improve performance, especially when dealing with large collections.</p>
- </li>
- </ul>
- <p>Example:</p>
- <pre class="prettyprint">// Limit the results to the top 10 highest-rated books<br>firestore.pipeline().collection("books")<br> .sort(field("rating").descending())<br> .limit(10);</pre>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>limit: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
- <td>
- <p>The maximum number of documents to return.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with this stage appended to the stage list.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="snapshots--"></a><a name="snapshots"></a>
- <h3 class="api-name" id="snapshots()">snapshots</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#snapshots()">snapshots</a>(): <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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></pre>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</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/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>A <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code> of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> that emits new snapshots on every change.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="snapshots-com.google.firebase.firestore.RealtimePipelineOptions-"></a><a name="snapshots"></a>
- <h3 class="api-name" id="snapshots(com.google.firebase.firestore.RealtimePipelineOptions)">snapshots</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#snapshots(com.google.firebase.firestore.RealtimePipelineOptions)">snapshots</a>(options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a>): <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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></pre>
- <p>Starts listening to this pipeline and emits a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> every time the results change.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>options: <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code></td>
- <td>
- <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code> to use for this listen.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <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/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a>></code></td>
- <td>
- <p>A <code><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a></code> of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSnapshot.html">RealtimePipelineSnapshot</a></code> that emits new snapshots on every change.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="sort(com.google.firebase.firestore.pipeline.Ordering, kotlin.Array)"></a><a name="sort-com.google.firebase.firestore.pipeline.Ordering-kotlin.Array-"></a><a name="sort"></a>
- <h3 class="api-name" id="sort(com.google.firebase.firestore.pipeline.Ordering,kotlin.Array)">sort</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#sort(com.google.firebase.firestore.pipeline.Ordering,kotlin.Array)">sort</a>(order: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a>, vararg additionalOrders: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Sorts the documents from previous stages based on one or more <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> criteria.</p>
- <p>This stage allows you to order the results of your pipeline. You can specify multiple <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> instances to sort by multiple fields in ascending or descending order. If documents have the same value for a field used for sorting, the next specified ordering will be used. If all orderings result in equal comparison, the documents are considered equal and the order is unspecified.</p>
- <p>Example:</p>
- <pre class="prettyprint">// Sort books by rating in descending order, and then by title in ascending order for books with the same rating<br>firestore.pipeline().collection("books")<br> .sort(<br> Ordering.of("rating").descending(),<br> Ordering.of("title") // Ascending order is the default<br> );</pre>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>order: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code></td>
- <td>
- <p>The first <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> instance specifying the sorting criteria.</p>
- </td>
- </tr>
- <tr>
- <td><code>vararg additionalOrders: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code></td>
- <td>
- <p>Optional additional <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/Ordering.html">Ordering</a></code> instances specifying the sorting criteria.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with this stage appended to the stage list.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </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">open fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#toString()">toString</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
- </div>
- <div class="api-item"><a name="where-com.google.firebase.firestore.pipeline.BooleanExpression-"></a><a name="where"></a>
- <h3 class="api-name" id="where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html#where(com.google.firebase.firestore.pipeline.BooleanExpression)">where</a>(condition: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Filters the documents from previous stages to only include those matching the specified <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code>.</p>
- <p>This stage allows you to apply conditions to the data, similar to a "WHERE" clause in SQL.</p>
- <p>You can filter documents based on their field values, using implementations of <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code>, typically including but not limited to:</p>
- <ul>
- <li>
- <p>field comparators: Expr.eq, Expr.lt (less than), Expr.gt (greater than), etc.</p>
- </li>
- <li>
- <p>logical operators: Expr.and, Expr.or, Expr.not, etc.</p>
- </li>
- <li>
- <p>advanced functions: Expr.arrayContains, Expr.eqAnyetc.</p>
- </li>
- </ul>
- <p>Example:</p>
- <pre class="prettyprint">firestore.pipeline().collection("books")<br> .where(<br> and(<br> gt("rating", 4.0), // Filter for ratings greater than 4.0<br> field("genre").eq("Science Fiction") // Equivalent to eq("genre", "Science Fiction")<br> )<br> );</pre>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>condition: <a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code></td>
- <td>
- <p>The <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/pipeline/BooleanExpression.html">BooleanExpression</a></code> to apply.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with this stage appended to the stage list.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </body>
-</html>
-
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html 2025-10-20 17:40:26.279395306 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html 1970-01-01 00:00:00.000000000 +0000
@@ -1,293 +0,0 @@
-<html devsite="true">
- <head>
- <title>RealtimePipelineSource</title>
-{% setvar book_path %}/_book.yaml{% endsetvar %}
-{% include "docs/reference/kotlin/_reference-head-tags.html" %}
- </head>
- <body>
- <div id="metadata-info-block"></div>
- <h1>RealtimePipelineSource</h1>
- <p>
- <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</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 functions</h3></th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collection(kotlin.String)">collection</a>(path: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Set the pipeline's source to the collection specified by the given path.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collection(com.google.firebase.firestore.CollectionReference)">collection</a>(ref: <a href="/docs/reference/kotlin/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a>)</code></div>
- <p>Set the pipeline's source to the collection specified by the given <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code>.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collectionGroup(kotlin.String)">collectionGroup</a>(collectionId: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
- <p>Set the pipeline's source to the collection group with the given id.</p>
- </td>
- </tr>
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">convertFrom</a>(query: <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>)</code></div>
- <p>Convert the given Query into an equivalent Pipeline.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="list">
- <h2>Public functions</h2>
- <div class="api-item"><a name="collection-kotlin.String-"></a><a name="collection"></a>
- <h3 class="api-name" id="collection(kotlin.String)">collection</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collection(kotlin.String)">collection</a>(path: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Set the pipeline's source to the collection specified by the given path.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>path: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
- <td>
- <p>A path to a collection that will be the source of this pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with documents from target collection.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="collection-com.google.firebase.firestore.CollectionReference-"></a><a name="collection"></a>
- <h3 class="api-name" id="collection(com.google.firebase.firestore.CollectionReference)">collection</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collection(com.google.firebase.firestore.CollectionReference)">collection</a>(ref: <a href="/docs/reference/kotlin/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Set the pipeline's source to the collection specified by the given <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code>.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>ref: <a href="/docs/reference/kotlin/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code></td>
- <td>
- <p>A <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/CollectionReference.html">CollectionReference</a></code> for a collection that will be the source of this pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with documents from target collection.</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>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>Thrown if the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collection(com.google.firebase.firestore.CollectionReference)">ref</a></code> provided targets a different project or database than the pipeline.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="collectionGroup-kotlin.String-"></a><a name="collectiongroup"></a>
- <h3 class="api-name" id="collectionGroup(kotlin.String)">collectionGroup</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#collectionGroup(kotlin.String)">collectionGroup</a>(collectionId: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Set the pipeline's source to the collection group with the given id.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>collectionId: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
- <td>
- <p>The id of a collection group that will be the source of this pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code> object with documents from target collection group.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <div class="api-item"><a name="convertFrom-com.google.firebase.firestore.Query-"></a><a name="convertfrom"></a>
- <h3 class="api-name" id="convertFrom(com.google.firebase.firestore.Query)">convertFrom</h3>
- <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">convertFrom</a>(query: <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></pre>
- <p>Convert the given Query into an equivalent Pipeline.</p>
- <div class="devsite-table-wrapper">
- <table class="responsive">
- <colgroup>
- <col width="40%">
- <col>
- </colgroup>
- <thead>
- <tr>
- <th colspan="100%">Parameters</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code>query: <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html">Query</a></code></td>
- <td>
- <p>A Query to be converted into a Pipeline.</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%">Returns</th>
- </tr>
- </thead>
- <tbody class="list">
- <tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td>
- <p>A new <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Pipeline.html">Pipeline</a></code> object that is equivalent to <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">query</a></code></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>kotlin.IllegalArgumentException: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html">kotlin.IllegalArgumentException</a></code></td>
- <td>
- <p>Thrown if the <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html#convertFrom(com.google.firebase.firestore.Query)">query</a></code> provided targets a different project or database than the pipeline.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- </div>
- </body>
-</html>
-
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2025-10-20 17:40:26.277325447 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2025-10-20 17:36:42.390830220 +0000
@@ -295,10 +295,6 @@
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipeline.html">RealtimePipeline</a></code></td>
- <td></td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineOptions.html">RealtimePipelineOptions</a></code></td>
<td>
<p>An options object that configures the behavior of <code>snapshots()</code> calls.</p>
@@ -311,10 +307,6 @@
</td>
</tr>
<tr>
- <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/RealtimePipelineSource.html">RealtimePipelineSource</a></code></td>
- <td></td>
- </tr>
- <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/SetOptions.html">SetOptions</a></code></td>
<td>
<p>An options object that configures the behavior of <code>set()</code> calls.</p>
Coverage Report 1
Affected Products
No changes between base commit (545ac38) and merge commit (41d3102).Test Logs
Test Results
0 tests 0 ✅ 0s ⏱️ 0 suites 0 💤 0 files 0 ❌
Results for commit edf508f3.
:recycle: This comment has been updated with latest results.
Size Report 1
Affected Products
baseType Base (545ac38) Merge (41d3102) Diff apk (aggressive) ? 8.80 kB ? (?) apk (release) ? 9.77 kB ? (?) firebase-firestoreType Base (545ac38) Merge (41d3102) Diff aar ? 2.23 MB ? (?) apk (aggressive) ? 559 kB ? (?) apk (release) ? 12.2 MB ? (?) protolite-well-known-typesType Base (545ac38) Merge (41d3102) Diff aar ? 1.02 MB ? (?) apk (aggressive) ? 134 kB ? (?) apk (release) ? 1.71 MB ? (?)
Test Logs
The public api surface has changed for the subproject firebase-firestore: error: Method com.google.firebase.firestore.Pipeline.execute has changed return type from com.google.android.gms.tasks.Task<com.google.firebase.firestore.PipelineSnapshot> to com.google.android.gms.tasks.Task<com.google.firebase.firestore.Pipeline.Snapshot> [ChangedType] error: Added method com.google.firebase.firestore.Pipeline.execute(com.google.firebase.firestore.Pipeline.ExecuteOptions) [AddedMethod] error: Removed method com.google.firebase.firestore.Pipeline.execute(com.google.firebase.firestore.pipeline.PipelineOptions) [RemovedMethod] error: Removed method com.google.firebase.firestore.Pipeline.findNearest(String,com.google.firebase.firestore.pipeline.Expr,com.google.firebase.firestore.pipeline.FindNearestStage.DistanceMeasure) [RemovedMethod] error: Added method com.google.firebase.firestore.Pipeline.findNearest(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.FindNearestStage.DistanceMeasure) [AddedMethod] error: Removed method com.google.firebase.firestore.Pipeline.findNearest(String,com.google.firebase.firestore.pipeline.Expr,com.google.firebase.firestore.pipeline.FindNearestStage.DistanceMeasure,com.google.firebase.firestore.pipeline.FindNearestOptions) [RemovedMethod] error: Added method com.google.firebase.firestore.Pipeline.findNearest(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.FindNearestStage.DistanceMeasure,com.google.firebase.firestore.pipeline.FindNearestOptions) [AddedMethod] error: Removed method com.google.firebase.firestore.Pipeline.replaceWith(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.Pipeline.replaceWith(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.Pipeline.where(com.google.firebase.firestore.pipeline.BooleanExpr) [RemovedMethod] error: Added method com.google.firebase.firestore.Pipeline.where(com.google.firebase.firestore.pipeline.BooleanExpression) [AddedMethod] error: Added class com.google.firebase.firestore.Pipeline.ExecuteOptions [AddedClass] error: Added class com.google.firebase.firestore.Pipeline.Snapshot [AddedClass] error: Removed class com.google.firebase.firestore.PipelineSnapshot [RemovedClass] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.average(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.average(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.avg(String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.avg(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.count(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.count(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.countDistinct(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.countDistinct(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.countIf(com.google.firebase.firestore.pipeline.BooleanExpr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.countIf(com.google.firebase.firestore.pipeline.BooleanExpression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.generic(String,com.google.firebase.firestore.pipeline.Expr...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.generic(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.maximum(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.maximum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.minimum(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.minimum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.sum(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.sum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.average(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.average(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.avg(String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.avg(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.count(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.count(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.countDistinct(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.countDistinct(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.countIf(com.google.firebase.firestore.pipeline.BooleanExpr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.countIf(com.google.firebase.firestore.pipeline.BooleanExpression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.generic(String,com.google.firebase.firestore.pipeline.Expr...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.generic(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.maximum(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.maximum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.minimum(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.minimum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.sum(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.AggregateFunction.Companion.sum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed class com.google.firebase.firestore.pipeline.AliasedExpr [RemovedClass] error: Added class com.google.firebase.firestore.pipeline.AliasedExpression [AddedClass] error: Removed class com.google.firebase.firestore.pipeline.BooleanExpr [RemovedClass] error: Added class com.google.firebase.firestore.pipeline.BooleanExpression [AddedClass] error: Removed class com.google.firebase.firestore.pipeline.Expr [RemovedClass] error: Added class com.google.firebase.firestore.pipeline.Expression [AddedClass] error: Removed field com.google.firebase.firestore.pipeline.Field.DOCUMENT_ID [RemovedField] error: Removed class com.google.firebase.firestore.pipeline.FunctionExpr [RemovedClass] error: Added class com.google.firebase.firestore.pipeline.FunctionExpression [AddedClass] error: Removed method com.google.firebase.firestore.pipeline.Ordering.ascending(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Ordering.ascending(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Ordering.descending(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Ordering.descending(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Method com.google.firebase.firestore.pipeline.Ordering.getExpr has changed return type from com.google.firebase.firestore.pipeline.Expr to com.google.firebase.firestore.pipeline.Expression [ChangedType] error: Removed method com.google.firebase.firestore.pipeline.Ordering.Companion.ascending(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Ordering.Companion.ascending(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Ordering.Companion.descending(com.google.firebase.firestore.pipeline.Expr) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Ordering.Companion.descending(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Class com.google.firebase.firestore.pipeline.Selectable superclass changed from com.google.firebase.firestore.pipeline.Expr to com.google.firebase.firestore.pipeline.Expression [ChangedSuperclass]
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: error: Removed method com.google.firebase.firestore.pipeline.AliasedExpression.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.BooleanExpression.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.BooleanExpression.ifError(com.google.firebase.firestore.pipeline.BooleanExpression) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.BooleanExpression.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.BooleanExpression.Companion.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.BooleanExpression.Companion.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.CollectionGroupSource.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.CollectionSource.canonicalId() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.abs() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.arraySum() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.arraySum(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.arraySum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.blob(byte[]) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.collectionId() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.collectionId(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.collectionId(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(String,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(String,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(com.google.firebase.firestore.pipeline.Expression,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.countDistinct() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.currentTimestamp() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.error(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.exp() [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(String,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(com.google.firebase.firestore.pipeline.Expression,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(String,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(com.google.firebase.firestore.pipeline.Expression,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.length() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.length(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.length(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ln() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.log10() [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.rand() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.stringReverse() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.stringReverse(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.stringReverse(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.arraySum(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.arraySum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.blob(byte[]) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.collectionId(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.collectionId(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(String,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(String,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(com.google.firebase.firestore.pipeline.Expression,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.currentTimestamp() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.error(String) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(String,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(com.google.firebase.firestore.pipeline.Expression,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(String,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(com.google.firebase.firestore.pipeline.Expression,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.length(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.length(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.rand() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.stringReverse(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.stringReverse(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Field.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.FunctionExpression.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Ordering.canonicalId() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Ordering.getDir() [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Ordering.reverse() [RemovedMethod] error: Added class com.google.firebase.firestore.pipeline.Ordering.Direction [AddedClass]
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: error: Removed method com.google.firebase.firestore.pipeline.AliasedExpression.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.BooleanExpression.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.BooleanExpression.ifError(com.google.firebase.firestore.pipeline.BooleanExpression) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.BooleanExpression.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.BooleanExpression.Companion.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.BooleanExpression.Companion.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.CollectionGroupSource.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.CollectionSource.canonicalId() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.abs() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.arraySum() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.arraySum(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.arraySum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.blob(byte[]) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.collectionId() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.collectionId(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.collectionId(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(String,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(String,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(com.google.firebase.firestore.pipeline.Expression,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.concat(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.countDistinct() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.currentTimestamp() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.error(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.exp() [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(String,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(com.google.firebase.firestore.pipeline.Expression,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ifAbsent(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(String,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(com.google.firebase.firestore.pipeline.Expression,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.join(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.length() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.length(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.length(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.ln() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.log10() [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.rand() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceAll(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.replaceFirst(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.stringReverse() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.stringReverse(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.stringReverse(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.arraySum(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.arraySum(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.blob(byte[]) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.collectionId(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.collectionId(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(String,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(String,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(com.google.firebase.firestore.pipeline.Expression,Object,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.concat(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,java.lang.Object...) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.currentTimestamp() [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.error(String) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.generic(String,com.google.firebase.firestore.pipeline.Expression...) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(String,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(com.google.firebase.firestore.pipeline.Expression,Object) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.ifAbsent(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(String,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(String,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(com.google.firebase.firestore.pipeline.Expression,String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.join(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.length(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.length(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.rand() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.rawFunction(String,com.google.firebase.firestore.pipeline.Expression...) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceAll(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(String,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(String,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(com.google.firebase.firestore.pipeline.Expression,String,String) [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Expression.Companion.replaceFirst(com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression,com.google.firebase.firestore.pipeline.Expression) [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.stringReverse(String) [AddedMethod] error: Added method com.google.firebase.firestore.pipeline.Expression.Companion.stringReverse(com.google.firebase.firestore.pipeline.Expression) [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Field.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.FunctionExpression.canonicalId() [RemovedMethod] error: Removed method com.google.firebase.firestore.pipeline.Ordering.canonicalId() [RemovedMethod] error: Added method com.google.firebase.firestore.pipeline.Ordering.getDir() [AddedMethod] error: Removed method com.google.firebase.firestore.pipeline.Ordering.reverse() [RemovedMethod] error: Added class com.google.firebase.firestore.pipeline.Ordering.Direction [AddedClass]
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.