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.

AggregateHints

class AggregateHints : AbstractOptions

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

Summary

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

Public functions
`open AggregateHints`	`self(options: InternalOptions)`
`AggregateHints`	`withForceStreamableEnabled()`

Inherited functions

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

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

Public constructors

AggregateHints

AggregateHints()

Creates a new, empty AggregateHints object.

Public functions

self

open fun self(options: InternalOptions): AggregateHints

withForceStreamableEnabled

fun withForceStreamableEnabled(): AggregateHints