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.

CollectionHints

class CollectionHints : AbstractOptions

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

Summary

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

Public functions
`open CollectionHints`	`self(options: InternalOptions)`
`CollectionHints`	`withForceIndex(value: String)` Forces the query to use a specific index.
`CollectionHints`	`withIgnoreIndexFields(vararg values: String)` Specifies fields to ignore in the index.

Inherited functions

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

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

Public constructors

CollectionHints

CollectionHints()

Creates a new, empty CollectionHints object.

Public functions

self

open fun self(options: InternalOptions): CollectionHints

withForceIndex

fun withForceIndex(value: String): CollectionHints

Forces the query to use a specific index.

Parameters
`value: String`	The name of the index to force.

Returns
`CollectionHints`	A new `CollectionHints` with the specified forced index.

withIgnoreIndexFields

fun withIgnoreIndexFields(vararg values: String): CollectionHints

Specifies fields to ignore in the index.

Parameters
`vararg values: String`	The names of the fields to ignore in the index.

Returns
`CollectionHints`	A new `CollectionHints` with the specified ignored index fields.