IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

AggregateQuery

class AggregateQuery

A query that calculates aggregations over an underlying query.

Subclassing Note: Cloud Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Summary

Public functions
`Boolean`	`equals(object: Any!)` Compares this object with the given object for equality.
`Task<AggregateQuerySnapshot!>`	`get(source: AggregateSource)` Executes this query.
`Int`	`hashCode()` Calculates and returns the hash code for this object.

Public properties
`Query`	`query`

Public functions

equals

fun equals(object: Any!): Boolean

Compares this object with the given object for equality.

This object is considered "equal" to the other object if and only if all of the following conditions are satisfied:

object is a non-null instance of AggregateQuery.
object performs the same aggregations as this AggregateQuery.
The underlying Query of object compares equal to that of this object.

Parameters
`object: Any!`	The object to compare to this object for equality.

Returns
`Boolean`	`true` if this object is "equal" to the given object, as defined above, or `false` otherwise.

get

fun get(source: AggregateSource): Task<AggregateQuerySnapshot!>

Executes this query.

Parameters
`source: AggregateSource`	The source from which to acquire the aggregate results.

Returns
`Task<AggregateQuerySnapshot!>`	A `Task` that will be resolved with the results of the query.

hashCode

fun hashCode(): Int

Calculates and returns the hash code for this object.

Returns
`Int`	the hash code for this object.

Public properties

query

val query: Query