-
Notifications
You must be signed in to change notification settings - Fork 578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Public sum/avg #5217
Public sum/avg #5217
Conversation
0eb1b45
to
495020b
Compare
Javadoc Changes:--- /Users/runner/diff/original/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/client/firebase-firestore/_toc.yaml 2023-10-16 18:47:05.000000000 +0000
@@ -24,6 +24,14 @@
- title: "Classes"
section:
+ - title: "AggregateField"
+ path: "/docs/reference/android/com/google/firebase/firestore/AggregateField.html"
+ - title: "AggregateField.AverageAggregateField"
+ path: "/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html"
+ - title: "AggregateField.CountAggregateField"
+ path: "/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html"
+ - title: "AggregateField.SumAggregateField"
+ path: "/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html"
- title: "AggregateQuery"
path: "/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html"
- title: "AggregateQuerySnapshot" --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,147 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField.AverageAggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField.AverageAggregateField</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> extends <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper">
+ <table class="jd-inheritance-table">
+ <tbody>
+ <tr>
+ <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
+ </tr>
+ <tr>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="2"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="1"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">com.google.firebase.firestore.AggregateField.AverageAggregateField</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <hr>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited fields</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>final @<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/AggregateField.html#alias()">alias</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="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/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</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> field)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</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> field)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,147 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField.CountAggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField.CountAggregateField</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> extends <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper">
+ <table class="jd-inheritance-table">
+ <tbody>
+ <tr>
+ <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
+ </tr>
+ <tr>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="2"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="1"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">com.google.firebase.firestore.AggregateField.CountAggregateField</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <hr>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited fields</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>final @<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/AggregateField.html#alias()">alias</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="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/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</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> field)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</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> field)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,147 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField.SumAggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField.SumAggregateField</h1>
+ <p>
+ <pre>public class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a> extends <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper">
+ <table class="jd-inheritance-table">
+ <tbody>
+ <tr>
+ <td colspan="3"><a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">java.lang.Object</a></td>
+ </tr>
+ <tr>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="2"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="1"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">com.google.firebase.firestore.AggregateField.SumAggregateField</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <hr>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited fields</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>final @<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/AggregateField.html#alias()">alias</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="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/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</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> field)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</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> field)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,439 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/android/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField</h1>
+ <p>
+ <pre>public abstract class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper"><devsite-expandable><span class="expand-control jd-sumtable-subclasses">Known direct subclasses
+ <div class="showalways" id="subclasses-direct"><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a>, <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a>, <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></div>
+ </span>
+ <div id="subclasses-direct-summary">
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+</devsite-expandable> </div>
+ <hr>
+ <p>Represents an aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>public class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> extends <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></div>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <div><code>public class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> extends <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></div>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <div><code>public class <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a> extends <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></div>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public fields</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>final @<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/AggregateField.html#alias()">alias</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="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/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public methods</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</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> field)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>boolean</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>int</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</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> field)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</code></div>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public fields</h2>
+ <div class="api-item"><a name="getAlias()"></a><a name="setAlias()"></a><a name="getAlias--"></a><a name="setAlias--"></a>
+ <h3 class="api-name" id="alias()">alias</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://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#alias()">alias</a></pre>
+ </div>
+ <div class="api-item"><a name="getOperator()"></a><a name="setOperator()"></a><a name="getOperator--"></a><a name="setOperator--"></a>
+ <h3 class="api-name" id="operator()">operator</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://developer.android.com/reference/kotlin/java/lang/String.html">String</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#operator()">operator</a></pre>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public methods</h2>
+ <div class="api-item"><a name="average-java.lang.String-"></a><a name="average"></a>
+ <h3 class="api-name" id="average(java.lang.String)">average</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</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> field)</pre>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of an average operation will always be a double or NaN. </p>
+ <ul>
+ <li>Averaging over zero documents or fields will result in a double value representing NaN. </li>
+ <li>Averaging over NaN will result in a double value representing NaN. </li>
+ </ul>
+ <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> field</code></td>
+ <td>
+ <p>Specifies the field to average across the result set.</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/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="average-com.google.firebase.firestore.FieldPath-"></a><a name="average"></a>
+ <h3 class="api-name" id="average(com.google.firebase.firestore.FieldPath)">average</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</pre>
+ <p>Create an <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of an average operation will always be a double or NaN. </p>
+ <ul>
+ <li>Averaging over zero documents or fields will result in a double value representing NaN. </li>
+ <li>Averaging over NaN will result in a double value representing NaN. </li>
+ </ul>
+ <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/FieldPath.html">FieldPath</a> fieldPath</code></td>
+ <td>
+ <p>Specifies the field to average across the result set.</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/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="count--"></a><a name="count"></a>
+ <h3 class="api-name" id="count()">count</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</pre>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query. </p>
+ <p>The result of a count operation will always be a 64-bit integer value.</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/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <p>The `CountAggregateField` object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> other)</pre>
+ <p>Returns true if the given object is equal to this object. Two `AggregateField` objects are considered equal if they have the same operator and operate on the same field.</p>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">public int <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</pre>
+ <p>Calculates and returns the hash code for this object.</p>
+ </div>
+ <div class="api-item"><a name="sum-java.lang.String-"></a><a name="sum"></a>
+ <h3 class="api-name" id="sum(java.lang.String)">sum</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</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> field)</pre>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of a sum operation will always be a 64-bit integer value, a double, or NaN. </p>
+ <ul>
+ <li>Summing over zero documents or fields will result in 0L. </li>
+ <li>Summing over NaN will result in a double value representing NaN. </li>
+ <li>A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result. </li>
+ <li>A sum that overflows the maximum representable double value will result in a double return value representing infinity. </li>
+ </ul>
+ <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> field</code></td>
+ <td>
+ <p>Specifies the field to sum across the result set.</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/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="sum-com.google.firebase.firestore.FieldPath-"></a><a name="sum"></a>
+ <h3 class="api-name" id="sum(com.google.firebase.firestore.FieldPath)">sum</h3>
+ <pre class="api-signature no-pretty-print">public static @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/firestore/FieldPath.html">FieldPath</a> fieldPath)</pre>
+ <p>Create a <code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of a sum operation will always be a 64-bit integer value, a double, or NaN. </p>
+ <ul>
+ <li>Summing over zero documents or fields will result in 0L. </li>
+ <li>Summing over NaN will result in a double value representing NaN. </li>
+ <li>A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result. </li>
+ <li>A sum that overflows the maximum representable double value will result in a double return value representing infinity. </li>
+ </ul>
+ <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/FieldPath.html">FieldPath</a> fieldPath</code></td>
+ <td>
+ <p>Specifies the field to sum across the result set.</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/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateQuerySnapshot.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/AggregateQuerySnapshot.html 2023-10-16 18:47:05.000000000 +0000
@@ -55,6 +55,27 @@
</td>
</tr>
<tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField)">get</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField)</code></div>
+ <p>Returns the result of the given aggregation from the server without coercion of data types.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Double.html">Double</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.AverageAggregateField)">get</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> averageAggregateField)</code></div>
+ <p>Returns the result of the given average aggregation.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>long</code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.CountAggregateField)">get</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> countAggregateField)</code></div>
+ <p>Returns the number of documents in the result set of the underlying query.</p>
+ </td>
+ </tr>
+ <tr>
<td><code>long</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getCount()">getCount</a>()</code></div>
@@ -62,6 +83,20 @@
</td>
</tr>
<tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Double.html">Double</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getDouble(com.google.firebase.firestore.AggregateField)">getDouble</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField)</code></div>
+ <p>Returns the result of the given aggregation as a double.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Long.html">Long</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getLong(com.google.firebase.firestore.AggregateField)">getLong</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField)</code></div>
+ <p>Returns the result of the given aggregation as a long.</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/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getQuery()">getQuery</a>()</code></div>
@@ -141,11 +176,246 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="get-com.google.firebase.firestore.AggregateField-"></a><a name="get"></a>
+ <h3 class="api-name" id="get(com.google.firebase.firestore.AggregateField)">get</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField)">get</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField)</pre>
+ <p>Returns the result of the given aggregation from the server without coercion of data types. Throws java.lang.RuntimeException if the `aggregateField` was not requested when calling `query.aggregate(...)`.</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="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField</code></td>
+ <td>
+ <p>The aggregation for which the value is requested.</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/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Object.html">Object</a></code></td>
+ <td>
+ <p>The result of the given aggregation.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="get-com.google.firebase.firestore.AggregateField.AverageAggregateField-"></a><a name="get"></a>
+ <h3 class="api-name" id="get(com.google.firebase.firestore.AggregateField.AverageAggregateField)">get</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Double.html">Double</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.AverageAggregateField)">get</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> averageAggregateField)</pre>
+ <p>Returns the result of the given average aggregation. Since the result of an average aggregation performed by the server is always a double, this convenience overload can be used in lieu of the above `get` method. Throws java.lang.RuntimeException if the `aggregateField` was not requested when calling `query.aggregate(...)`.</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="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> averageAggregateField</code></td>
+ <td>
+ <p>The average aggregation for which the value is requested.</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/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Double.html">Double</a></code></td>
+ <td>
+ <p>The result of the given average aggregation.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="get-com.google.firebase.firestore.AggregateField.CountAggregateField-"></a><a name="get"></a>
+ <h3 class="api-name" id="get(com.google.firebase.firestore.AggregateField.CountAggregateField)">get</h3>
+ <pre class="api-signature no-pretty-print">public long <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.CountAggregateField)">get</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> countAggregateField)</pre>
+ <p>Returns the number of documents in the result set of the underlying query.</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="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> countAggregateField</code></td>
+ <td>
+ <p>The count aggregation for which the value is requested.</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>long</code></td>
+ <td>
+ <p>The result of the given count aggregation.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="getCount--"></a><a name="getcount"></a>
<h3 class="api-name" id="getCount()">getCount</h3>
<pre class="api-signature no-pretty-print">public long <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getCount()">getCount</a>()</pre>
<p>Returns the number of documents in the result set of the underlying query.</p>
</div>
+ <div class="api-item"><a name="getDouble-com.google.firebase.firestore.AggregateField-"></a><a name="getdouble"></a>
+ <h3 class="api-name" id="getDouble(com.google.firebase.firestore.AggregateField)">getDouble</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Double.html">Double</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getDouble(com.google.firebase.firestore.AggregateField)">getDouble</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField)</pre>
+ <p>Returns the result of the given aggregation as a double. Coerces all numeric values and throws a RuntimeException if the result of the aggregate is non-numeric. In the case of coercion of long to double, uses java.lang.Long.doubleValue to perform the conversion, and may result in a loss of precision.</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="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField</code></td>
+ <td>
+ <p>The aggregation for which the value is requested.</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/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Double.html">Double</a></code></td>
+ <td>
+ <p>The result of the given average aggregation as a double.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="getLong-com.google.firebase.firestore.AggregateField-"></a><a name="getlong"></a>
+ <h3 class="api-name" id="getLong(com.google.firebase.firestore.AggregateField)">getLong</h3>
+ <pre class="api-signature no-pretty-print">public @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Long.html">Long</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getLong(com.google.firebase.firestore.AggregateField)">getLong</a>(@<a href="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField)</pre>
+ <p>Returns the result of the given aggregation as a long. Coerces all numeric values and throws a RuntimeException if the result of the aggregate is non-numeric. In case of coercion of double to long, uses java.lang.Double.longValue to perform the conversion.</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="/docs/reference/android/javax/annotation/Nonnull.html">Nonnull</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a> aggregateField</code></td>
+ <td>
+ <p>The aggregation for which the value is requested.</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/Nullable.html">Nullable</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Long.html">Long</a></code></td>
+ <td>
+ <p>The result of the given average aggregation as a long.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="getQuery--"></a><a name="getquery"></a>
<h3 class="api-name" id="getQuery()">getQuery</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/AggregateQuery.html">AggregateQuery</a> <a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuerySnapshot.html#getQuery()">getQuery</a>()</pre> --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/CollectionReference.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/CollectionReference.html 2023-10-16 18:47:05.000000000 +0000
@@ -181,6 +181,13 @@
<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/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</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/AggregateField.html">AggregateField</a> aggregateField,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> AggregateField[] aggregateFields<br>)</code></div>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</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/AggregateQuery.html">AggregateQuery</a></code></td>
+ <td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#count()">count</a>()</code></div>
<p>Returns a query that counts the documents in the result set of this query.</p>
</td> --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/Query.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/Query.html 2023-10-16 18:47:05.000000000 +0000
@@ -135,6 +135,13 @@
<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/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
+ <div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</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/AggregateField.html">AggregateField</a> aggregateField,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> AggregateField[] aggregateFields<br>)</code></div>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</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/AggregateQuery.html">AggregateQuery</a></code></td>
+ <td>
<div><code><a href="/docs/reference/android/com/google/firebase/firestore/Query.html#count()">count</a>()</code></div>
<p>Returns a query that counts the documents in the result set of this query.</p>
</td>
@@ -801,6 +808,33 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="aggregate(com.google.firebase.firestore.AggregateField, com.google.firebase.firestore.AggregateField...)"></a><a name="aggregate-com.google.firebase.firestore.AggregateField-com.google.firebase.firestore.AggregateField...-"></a><a name="aggregate"></a>
+ <h3 class="api-name" id="aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</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/AggregateQuery.html">AggregateQuery</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</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/AggregateField.html">AggregateField</a> aggregateField,<br> @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> AggregateField[] aggregateFields<br>)</pre>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents. </p>
+ <p>Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. This function can even perform aggregations of the documents if the result set would be prohibitively large to download entirely (e.g. thousands of documents).</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/AggregateQuery.html">AggregateQuery</a></code></td>
+ <td>
+ <p>The <code>AggregateQuery</code> that performs aggregations on the documents in the result set of this query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="count--"></a><a name="count"></a>
<h3 class="api-name" id="count()">count</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/AggregateQuery.html">AggregateQuery</a> <a href="/docs/reference/android/com/google/firebase/firestore/Query.html#count()">count</a>()</pre> --- /Users/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/firestore/package-summary.html 2023-10-16 18:47:05.000000000 +0000
@@ -113,6 +113,30 @@
</colgroup>
<tbody class="list">
<tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></td>
+ <td>
+ <p>Represents an aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/android/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<p>A query that calculates aggregations over an underlying query.</p> --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/client/firebase-firestore/_toc.yaml 2023-10-16 18:47:05.000000000 +0000
@@ -24,6 +24,14 @@
- title: "Classes"
section:
+ - title: "AggregateField"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html"
+ - title: "AggregateField.AverageAggregateField"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html"
+ - title: "AggregateField.CountAggregateField"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html"
+ - title: "AggregateField.SumAggregateField"
+ path: "/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html"
- title: "AggregateQuery"
path: "/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html"
- title: "AggregateQuerySnapshot" --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,147 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField.AverageAggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField.AverageAggregateField</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper">
+ <table class="jd-inheritance-table">
+ <tbody>
+ <tr>
+ <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
+ </tr>
+ <tr>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="2"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">com.google.firebase.firestore.AggregateField.AverageAggregateField</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <hr>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited properties</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#alias()">alias</a></code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,147 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField.CountAggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField.CountAggregateField</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper">
+ <table class="jd-inheritance-table">
+ <tbody>
+ <tr>
+ <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
+ </tr>
+ <tr>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="2"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">com.google.firebase.firestore.AggregateField.CountAggregateField</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <hr>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited properties</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#alias()">alias</a></code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,147 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField.SumAggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField.SumAggregateField</h1>
+ <p>
+ <pre>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper">
+ <table class="jd-inheritance-table">
+ <tbody>
+ <tr>
+ <td colspan="3"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">kotlin.Any</a></td>
+ </tr>
+ <tr>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="2"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></td>
+ </tr>
+ <tr>
+ <td> </td>
+ <td class="jd-inheritance-space"> ↳</td>
+ <td colspan="1"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">com.google.firebase.firestore.AggregateField.SumAggregateField</a></td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <hr>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive" id="inhmethods">
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Inherited properties</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><devsite-expandable><span class="expand-control">From <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">com.google.firebase.firestore.AggregateField</a></span>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#alias()">alias</a></code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+</devsite-expandable> </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.html 1970-01-01 00:00:00.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateField.html 2023-10-16 18:47:05.000000000 +0000
@@ -0,0 +1,439 @@
+<html devsite="true">
+ <head>
+ <title>AggregateField</title>
+{% setvar book_path %}/_book.yaml{% endsetvar %}
+{% include "docs/reference/kotlin/_reference-head-tags.html" %}
+ </head>
+ <body>
+ <div id="metadata-info-block"></div>
+ <h1>AggregateField</h1>
+ <p>
+ <pre>abstract class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></pre>
+ </p>
+ <div class="devsite-table-wrapper"><devsite-expandable><span class="expand-control jd-sumtable-subclasses">Known direct subclasses
+ <div class="showalways" id="subclasses-direct"><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a>, <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a>, <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></div>
+ </span>
+ <div id="subclasses-direct-summary">
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+</devsite-expandable> </div>
+ <hr>
+ <p>Represents an aggregation that can be performed by Firestore.</p>
+ <h2>Summary</h2>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Nested types</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td>
+ <div><code>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></div>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <div><code>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></div>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <div><code>class <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a> : <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></div>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public functions</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#count()">count</a>()</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">equals</a>(other: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>!)</code></div>
+ <p>Returns true if the given object is equal to this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>()</code></div>
+ <p>Calculates and returns the hash code for this object.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>java-static <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>)</code></div>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="devsite-table-wrapper">
+ <table class="responsive">
+ <colgroup>
+ <col width="40%">
+ <col>
+ </colgroup>
+ <thead>
+ <tr>
+ <th colspan="100%"><h3>Public properties</h3></th>
+ </tr>
+ </thead>
+ <tbody class="list">
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#alias()">alias</a></code></div>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#operator()">operator</a></code></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ <div class="list">
+ <h2>Public functions</h2>
+ <div class="api-item"><a name="average-java.lang.String-"></a><a name="average"></a>
+ <h3 class="api-name" id="average(java.lang.String)">average</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(java.lang.String)">average</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></pre>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of an average operation will always be a double or NaN. </p>
+ <ul>
+ <li>Averaging over zero documents or fields will result in a double value representing NaN. </li>
+ <li>Averaging over NaN will result in a double value representing NaN. </li>
+ </ul>
+ <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>field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Specifies the field to average across the result set.</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/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="average-com.google.firebase.firestore.FieldPath-"></a><a name="average"></a>
+ <h3 class="api-name" id="average(com.google.firebase.firestore.FieldPath)">average</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#average(com.google.firebase.firestore.FieldPath)">average</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></pre>
+ <p>Create an <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AverageAggregateField</a></code> object that can be used to compute the average of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of an average operation will always be a double or NaN. </p>
+ <ul>
+ <li>Averaging over zero documents or fields will result in a double value representing NaN. </li>
+ <li>Averaging over NaN will result in a double value representing NaN. </li>
+ </ul>
+ <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>fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a></code></td>
+ <td>
+ <p>Specifies the field to average across the result set.</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/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>The `AverageAggregateField` object that can be used to compute the average of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="count--"></a><a name="count"></a>
+ <h3 class="api-name" id="count()">count</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#count()">count</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></pre>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">CountAggregateField</a></code> object that can be used to compute the count of documents in the result set of a query. </p>
+ <p>The result of a count operation will always be a 64-bit integer value.</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/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <p>The `CountAggregateField` object that can be used to compute the count of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="equals-java.lang.Object-"></a><a name="equals"></a>
+ <h3 class="api-name" id="equals(java.lang.Object)">equals</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#equals(java.lang.Object)">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>
+ <p>Returns true if the given object is equal to this object. Two `AggregateField` objects are considered equal if they have the same operator and operate on the same field.</p>
+ </div>
+ <div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
+ <h3 class="api-name" id="hashCode()">hashCode</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#hashCode()">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre>
+ <p>Calculates and returns the hash code for this object.</p>
+ </div>
+ <div class="api-item"><a name="sum-java.lang.String-"></a><a name="sum"></a>
+ <h3 class="api-name" id="sum(java.lang.String)">sum</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(java.lang.String)">sum</a>(field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></pre>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of a sum operation will always be a 64-bit integer value, a double, or NaN. </p>
+ <ul>
+ <li>Summing over zero documents or fields will result in 0L. </li>
+ <li>Summing over NaN will result in a double value representing NaN. </li>
+ <li>A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result. </li>
+ <li>A sum that overflows the maximum representable double value will result in a double return value representing infinity. </li>
+ </ul>
+ <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>field: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></code></td>
+ <td>
+ <p>Specifies the field to sum across the result set.</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/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="sum-com.google.firebase.firestore.FieldPath-"></a><a name="sum"></a>
+ <h3 class="api-name" id="sum(com.google.firebase.firestore.FieldPath)">sum</h3>
+ <pre class="api-signature no-pretty-print">java-static fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#sum(com.google.firebase.firestore.FieldPath)">sum</a>(fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></pre>
+ <p>Create a <code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">SumAggregateField</a></code> object that can be used to compute the sum of a specified field over a range of documents in the result set of a query. </p>
+ <p>The result of a sum operation will always be a 64-bit integer value, a double, or NaN. </p>
+ <ul>
+ <li>Summing over zero documents or fields will result in 0L. </li>
+ <li>Summing over NaN will result in a double value representing NaN. </li>
+ <li>A sum that overflows the maximum representable 64-bit integer value will result in a double return value. This may result in lost precision of the result. </li>
+ <li>A sum that overflows the maximum representable double value will result in a double return value representing infinity. </li>
+ </ul>
+ <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>fieldPath: <a href="/docs/reference/kotlin/com/google/firebase/firestore/FieldPath.html">FieldPath</a></code></td>
+ <td>
+ <p>Specifies the field to sum across the result set.</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/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>The `SumAggregateField` object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ </div>
+ <div class="list">
+ <h2>Public properties</h2>
+ <div class="api-item"><a name="getAlias()"></a><a name="setAlias()"></a><a name="getAlias--"></a><a name="setAlias--"></a>
+ <h3 class="api-name" id="alias()">alias</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#alias()">alias</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ </div>
+ <div class="api-item"><a name="getOperator()"></a><a name="setOperator()"></a><a name="getOperator--"></a><a name="setOperator--"></a>
+ <h3 class="api-name" id="operator()">operator</h3>
+ <pre class="api-signature no-pretty-print">val <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html#operator()">operator</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></pre>
+ </div>
+ </div>
+ </body>
+</html>
+ --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html 2023-10-16 18:47:05.000000000 +0000
@@ -34,6 +34,27 @@
</td>
</tr>
<tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField)">get</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!)</code></div>
+ <p>Returns the result of the given aggregation from the server without coercion of data types.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.AverageAggregateField)">get</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> averageAggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a>!)</code></div>
+ <p>Returns the result of the given average aggregation.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.CountAggregateField)">get</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> countAggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a>!)</code></div>
+ <p>Returns the number of documents in the result set of the underlying query.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#getCount()">getCount</a>()</code></div>
@@ -41,6 +62,20 @@
</td>
</tr>
<tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#getDouble(com.google.firebase.firestore.AggregateField)">getDouble</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!)</code></div>
+ <p>Returns the result of the given aggregation as a double.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>?</code></td>
+ <td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#getLong(com.google.firebase.firestore.AggregateField)">getLong</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!)</code></div>
+ <p>Returns the result of the given aggregation as a long.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#hashCode()">hashCode</a>()</code></div>
@@ -127,11 +162,246 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="get-com.google.firebase.firestore.AggregateField-"></a><a name="get"></a>
+ <h3 class="api-name" id="get(com.google.firebase.firestore.AggregateField)">get</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField)">get</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</pre>
+ <p>Returns the result of the given aggregation from the server without coercion of data types. Throws java.lang.RuntimeException if the `aggregateField` was not requested when calling `query.aggregate(...)`.</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="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!</code></td>
+ <td>
+ <p>The aggregation for which the value is requested.</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/latest/jvm/stdlib/kotlin/-any/index.html">Any</a>?</code></td>
+ <td>
+ <p>The result of the given aggregation.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="get-com.google.firebase.firestore.AggregateField.AverageAggregateField-"></a><a name="get"></a>
+ <h3 class="api-name" id="get(com.google.firebase.firestore.AggregateField.AverageAggregateField)">get</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.AverageAggregateField)">get</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> averageAggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>?</pre>
+ <p>Returns the result of the given average aggregation. Since the result of an average aggregation performed by the server is always a double, this convenience overload can be used in lieu of the above `get` method. Throws java.lang.RuntimeException if the `aggregateField` was not requested when calling `query.aggregate(...)`.</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="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> averageAggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a>!</code></td>
+ <td>
+ <p>The average aggregation for which the value is requested.</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/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>?</code></td>
+ <td>
+ <p>The result of the given average aggregation.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="get-com.google.firebase.firestore.AggregateField.CountAggregateField-"></a><a name="get"></a>
+ <h3 class="api-name" id="get(com.google.firebase.firestore.AggregateField.CountAggregateField)">get</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#get(com.google.firebase.firestore.AggregateField.CountAggregateField)">get</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> countAggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></pre>
+ <p>Returns the number of documents in the result set of the underlying query.</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="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> countAggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a>!</code></td>
+ <td>
+ <p>The count aggregation for which the value is requested.</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/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></code></td>
+ <td>
+ <p>The result of the given count aggregation.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="getCount--"></a><a name="getcount"></a>
<h3 class="api-name" id="getCount()">getCount</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#getCount()">getCount</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></pre>
<p>Returns the number of documents in the result set of the underlying query.</p>
</div>
+ <div class="api-item"><a name="getDouble-com.google.firebase.firestore.AggregateField-"></a><a name="getdouble"></a>
+ <h3 class="api-name" id="getDouble(com.google.firebase.firestore.AggregateField)">getDouble</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#getDouble(com.google.firebase.firestore.AggregateField)">getDouble</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>?</pre>
+ <p>Returns the result of the given aggregation as a double. Coerces all numeric values and throws a RuntimeException if the result of the aggregate is non-numeric. In the case of coercion of long to double, uses java.lang.Long.doubleValue to perform the conversion, and may result in a loss of precision.</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="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!</code></td>
+ <td>
+ <p>The aggregation for which the value is requested.</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/latest/jvm/stdlib/kotlin/-double/index.html">Double</a>?</code></td>
+ <td>
+ <p>The result of the given average aggregation as a double.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
+ <div class="api-item"><a name="getLong-com.google.firebase.firestore.AggregateField-"></a><a name="getlong"></a>
+ <h3 class="api-name" id="getLong(com.google.firebase.firestore.AggregateField)">getLong</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#getLong(com.google.firebase.firestore.AggregateField)">getLong</a>(@<a href="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>?</pre>
+ <p>Returns the result of the given aggregation as a long. Coerces all numeric values and throws a RuntimeException if the result of the aggregate is non-numeric. In case of coercion of double to long, uses java.lang.Double.longValue to perform the conversion.</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="/docs/reference/kotlin/javax/annotation/Nonnull.html">Nonnull</a> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!</code></td>
+ <td>
+ <p>The aggregation for which the value is requested.</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/latest/jvm/stdlib/kotlin/-long/index.html">Long</a>?</code></td>
+ <td>
+ <p>The result of the given average aggregation as a long.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="hashCode--"></a><a name="hashcode"></a>
<h3 class="api-name" id="hashCode()">hashCode</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuerySnapshot.html#hashCode()">hashCode</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre> --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/CollectionReference.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/CollectionReference.html 2023-10-16 18:47:05.000000000 +0000
@@ -150,6 +150,13 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>,<br> aggregateFields: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!><br>)</code></div>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
+ <td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#count()">count</a>()</code></div>
<p>Returns a query that counts the documents in the result set of this query.</p>
</td> --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/Query.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/Query.html 2023-10-16 18:47:05.000000000 +0000
@@ -114,6 +114,13 @@
<tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
+ <div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>,<br> aggregateFields: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!><br>)</code></div>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
+ <td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#count()">count</a>()</code></div>
<p>Returns a query that counts the documents in the result set of this query.</p>
</td>
@@ -787,6 +794,33 @@
</table>
</div>
</div>
+ <div class="api-item"><a name="aggregate(com.google.firebase.firestore.AggregateField, com.google.firebase.firestore.AggregateField...)"></a><a name="aggregate-com.google.firebase.firestore.AggregateField-com.google.firebase.firestore.AggregateField...-"></a><a name="aggregate"></a>
+ <h3 class="api-name" id="aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</h3>
+ <pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#aggregate(com.google.firebase.firestore.AggregateField,com.google.firebase.firestore.AggregateField...)">aggregate</a>(<br> aggregateField: <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>,<br> aggregateFields: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><<a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a>!><br>): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></pre>
+ <p>Calculates the specified aggregations over the documents in the result set of the given query, without actually downloading the documents. </p>
+ <p>Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. This function can even perform aggregations of the documents if the result set would be prohibitively large to download entirely (e.g. thousands of documents).</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/AggregateQuery.html">AggregateQuery</a></code></td>
+ <td>
+ <p>The <code>AggregateQuery</code> that performs aggregations on the documents in the result set of this query.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+ </div>
<div class="api-item"><a name="count--"></a><a name="count"></a>
<h3 class="api-name" id="count()">count</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/firestore/Query.html#count()">count</a>(): <a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></pre> --- /Users/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2023-10-16 18:49:55.000000000 +0000
+++ /Users/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/firestore/package-summary.html 2023-10-16 18:47:05.000000000 +0000
@@ -66,6 +66,30 @@
</colgroup>
<tbody class="list">
<tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.html">AggregateField</a></code></td>
+ <td>
+ <p>Represents an aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.AverageAggregateField.html">AggregateField.AverageAggregateField</a></code></td>
+ <td>
+ <p>Represents an "average" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.CountAggregateField.html">AggregateField.CountAggregateField</a></code></td>
+ <td>
+ <p>Represents a "count" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
+ <td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateField.SumAggregateField.html">AggregateField.SumAggregateField</a></code></td>
+ <td>
+ <p>Represents a "sum" aggregation that can be performed by Firestore.</p>
+ </td>
+ </tr>
+ <tr>
<td><code><a href="/docs/reference/kotlin/com/google/firebase/firestore/AggregateQuery.html">AggregateQuery</a></code></td>
<td>
<p>A query that calculates aggregations over an underlying query.</p> |
Coverage Report 1Affected Products
Test Logs |
Unit Test Results 180 files - 756 180 suites - 756 2m 56s ⏱️ - 36m 22s Results for commit 6dbe9de. ± Comparison against base commit 406c057. ♻️ This comment has been updated with latest results. |
The public api surface has changed for the subproject firebase-firestore: Please update the api.txt files for the subprojects being affected by this change by running ./gradlew ${subproject}:generateApiTxtFile. Also perform a major/minor bump accordingly. |
Size Report 1Affected Products
Test Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
5d8e24e
to
fe29491
Compare
fe29491
to
bcb4f92
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
javadoc is missing from AggregateField.java
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a few comments that should be addressed, but otherwise LGTM.
firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateQuerySnapshot.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateQuerySnapshot.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/core/Query.java
Outdated
Show resolved
Hide resolved
01b3e66
to
c78b50e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. We do two minor documentation tweaks. They will also be fixed in iOS.
firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateField.java
Outdated
Show resolved
Hide resolved
firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateField.java
Outdated
Show resolved
Hide resolved
…-sdk into cheryllin/sum-avg-public
…se-android-sdk into cheryllin/sum-avg-public
…se-android-sdk into cheryllin/sum-avg-public
…-sdk into cheryllin/sum-avg-public
…se-android-sdk into cheryllin/sum-avg-public
No description provided.