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.

CollectionSourceOptions

class CollectionSourceOptions : AbstractOptions

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

Summary

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

Public functions
`CollectionSourceOptions`	`withHints(hints: CollectionHints)` Specifies query hints for the collection source.

Inherited functions

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

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

Public constructors

CollectionSourceOptions

CollectionSourceOptions()

Creates a new, empty CollectionSourceOptions object.

Public functions

withHints

fun withHints(hints: CollectionHints): CollectionSourceOptions

Specifies query hints for the collection source.

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

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