AggregateQuerySnapshot

class AggregateQuerySnapshot

The results of executing an AggregateQuery.

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.
`Any?`	`get(aggregateField: AggregateField)` Returns the result of the given aggregation from the server without coercion of data types.
`Double?`	`get(averageAggregateField: AggregateField.AverageAggregateField)` Returns the result of the given average aggregation.
`Long`	`get(countAggregateField: AggregateField.CountAggregateField)` Returns the number of documents in the result set of the underlying query.
`Long`	`getCount()` Returns the number of documents in the result set of the underlying query.
`Double?`	`getDouble(aggregateField: AggregateField)` Returns the result of the given aggregation as a double.
`Long?`	`getLong(aggregateField: AggregateField)` Returns the result of the given aggregation as a long.
`Int`	`hashCode()` Calculates and returns the hash code for this object.

Public properties
`AggregateQuery`	`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 AggregateQuerySnapshot.
The AggregateQuery of object compares equal to that of this object.
object has the same results as 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(aggregateField: AggregateField): Any?

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(...)`.

Parameters
`aggregateField: AggregateField`	The aggregation for which the value is requested.

Returns
`Any?`	The result of the given aggregation.

get

fun get(averageAggregateField: AggregateField.AverageAggregateField): Double?

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(...)`.

Parameters
`averageAggregateField: AggregateField.AverageAggregateField`	The average aggregation for which the value is requested.

Returns
`Double?`	The result of the given average aggregation.

get

fun get(countAggregateField: AggregateField.CountAggregateField): Long

Returns the number of documents in the result set of the underlying query.

Parameters
`countAggregateField: AggregateField.CountAggregateField`	The count aggregation for which the value is requested.

Returns
`Long`	The result of the given count aggregation.

getCount

fun getCount(): Long

Returns the number of documents in the result set of the underlying query.

getDouble

fun getDouble(aggregateField: AggregateField): Double?

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.

Parameters
`aggregateField: AggregateField`	The aggregation for which the value is requested.

Returns
`Double?`	The result of the given average aggregation as a double.

getLong

fun getLong(aggregateField: AggregateField): Long?

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.

Parameters
`aggregateField: AggregateField`	The aggregation for which the value is requested.

Returns
`Long?`	The result of the given average aggregation as a long.

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: AggregateQuery