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.

AggregateOptions

class AggregateOptions : AbstractOptions

kotlin.Any
↳	com.google.firebase.firestore.pipeline.AbstractOptions
	↳	com.google.firebase.firestore.pipeline.AggregateOptions

Summary

Public constructors
`AggregateOptions()` Creates a new, empty `AggregateOptions` object.

Public functions
`open AggregateOptions`	`self(options: InternalOptions)`
`AggregateOptions`	`withHints(hints: AggregateHints)` Specifies query hints for the aggregation.

Inherited functions

From com.google.firebase.firestore.pipeline.AbstractOptions

`AggregateOptions`	`adding(newOptions: AbstractOptions<*>)`
`AggregateOptions`	`with(key: String, subSection: AbstractOptions<*>)`
`AggregateOptions`	`with(key: String, value: <Error class: unknown class>)`
`AggregateOptions`	`with(key: String, value: Boolean)` Specify generic `Boolean` option
`AggregateOptions`	`with(key: String, value: Double)` Specify generic `Double` option
`AggregateOptions`	`with(key: String, value: Field)` Specify generic `Field` option
`AggregateOptions`	`with(key: String, value: InternalOptions)`
`AggregateOptions`	`with(key: String, value: Long)` Specify generic `Long` option
`AggregateOptions`	`with(key: String, value: RawOptions)` Specify `RawOptions` object
`AggregateOptions`	`with(key: String, value: String)` Specify generic `String` option
`AggregateOptions`	`with(key: String, vararg values: String)`

Public constructors

AggregateOptions

AggregateOptions()

Creates a new, empty AggregateOptions object.

Public functions

self

open fun self(options: InternalOptions): AggregateOptions

withHints

fun withHints(hints: AggregateHints): AggregateOptions

Specifies query hints for the aggregation.

Parameters
`hints: AggregateHints`	The hints to apply to the aggregation.

Returns
`AggregateOptions`	A new `AggregateOptions` with the specified hints.