Public sum/avg

firebase-firestore/CHANGELOG.md

@@ -1,9 +1,9 @@
 # Unreleased
+* [feature] Expose Sum/Average aggregate query support in API. [#5217](//github.com/firebase/firebase-android-sdk/pull/5217)
 * [changed] Added Kotlin extensions (KTX) APIs from `com.google.firebase:firebase-firestore-ktx`
   to `com.google.firebase:firebase-firestore` under the `com.google.firebase.firestore` package.
   For details, see the
   [FAQ about this initiative](https://firebase.google.com/docs/android/kotlin-migration)
-
 * [deprecated] All the APIs from `com.google.firebase:firebase-firestore-ktx` have been added to
   `com.google.firebase:firebase-firestore` under the `com.google.firebase.firestore` package,
   and all the Kotlin extensions (KTX) APIs in `com.google.firebase:firebase-firestore-ktx` are

firebase-firestore/api.txt

@@ -19,13 +19,39 @@ package com.google.firebase {
 
 package com.google.firebase.firestore {
 
+  public abstract class AggregateField {
+    method @NonNull public static com.google.firebase.firestore.AggregateField.AverageAggregateField average(@NonNull String);
+    method @NonNull public static com.google.firebase.firestore.AggregateField.AverageAggregateField average(@NonNull com.google.firebase.firestore.FieldPath);
+    method @NonNull public static com.google.firebase.firestore.AggregateField.CountAggregateField count();
+    method @NonNull @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY) public String getAlias();
+    method @NonNull @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY) public String getFieldPath();
+    method @NonNull @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY) public String getOperator();
+    method @NonNull public static com.google.firebase.firestore.AggregateField.SumAggregateField sum(@NonNull String);
+    method @NonNull public static com.google.firebase.firestore.AggregateField.SumAggregateField sum(@NonNull com.google.firebase.firestore.FieldPath);
+  }
+
+  public static class AggregateField.AverageAggregateField extends com.google.firebase.firestore.AggregateField {
+  }
+
+  public static class AggregateField.CountAggregateField extends com.google.firebase.firestore.AggregateField {
+  }
+
+  public static class AggregateField.SumAggregateField extends com.google.firebase.firestore.AggregateField {
+  }
+
   public class AggregateQuery {
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.firestore.AggregateQuerySnapshot> get(@NonNull com.google.firebase.firestore.AggregateSource);
+    method @NonNull @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY) public java.util.List<com.google.firebase.firestore.AggregateField> getAggregateFields();
     method @NonNull public com.google.firebase.firestore.Query getQuery();
   }
 
   public class AggregateQuerySnapshot {
+    method @Nullable public Object get(@NonNull com.google.firebase.firestore.AggregateField);
+    method public long get(@NonNull com.google.firebase.firestore.AggregateField.CountAggregateField);
+    method @Nullable public Double get(@NonNull com.google.firebase.firestore.AggregateField.AverageAggregateField);
     method public long getCount();
+    method @Nullable public Double getDouble(@NonNull com.google.firebase.firestore.AggregateField);
+    method @Nullable public Long getLong(@NonNull com.google.firebase.firestore.AggregateField);
     method @NonNull public com.google.firebase.firestore.AggregateQuery getQuery();
   }
 
@@ -411,6 +437,7 @@ package com.google.firebase.firestore {
     method @NonNull public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(@NonNull com.google.firebase.firestore.MetadataChanges, @NonNull com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>);
     method @NonNull public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(@NonNull java.util.concurrent.Executor, @NonNull com.google.firebase.firestore.MetadataChanges, @NonNull com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>);
     method @NonNull public com.google.firebase.firestore.ListenerRegistration addSnapshotListener(@NonNull android.app.Activity, @NonNull com.google.firebase.firestore.MetadataChanges, @NonNull com.google.firebase.firestore.EventListener<com.google.firebase.firestore.QuerySnapshot>);
+    method @NonNull public com.google.firebase.firestore.AggregateQuery aggregate(@NonNull com.google.firebase.firestore.AggregateField, @NonNull com.google.firebase.firestore.AggregateField...);
     method @NonNull public com.google.firebase.firestore.AggregateQuery count();
     method @NonNull public com.google.firebase.firestore.Query endAt(@NonNull com.google.firebase.firestore.DocumentSnapshot);
     method @NonNull public com.google.firebase.firestore.Query endAt(java.lang.Object...);