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.

CollectionGroupOptions

class CollectionGroupOptions : AbstractOptions

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

Summary

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

Public functions
`open CollectionGroupOptions`	`self(options: InternalOptions)`
`CollectionGroupOptions`	`withHints(hints: CollectionHints)` Specifies query hints for the collection group source.

Inherited functions

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

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

Public constructors

CollectionGroupOptions

CollectionGroupOptions()

Creates a new, empty CollectionGroupOptions object.

Public functions

self

open fun self(options: InternalOptions): CollectionGroupOptions

withHints

fun withHints(hints: CollectionHints): CollectionGroupOptions

Specifies query hints for the collection group source.

Parameters
`hints: CollectionHints`	The hints to apply to the collection group source.

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