firebase-firestore/com.google.firebase.firestore.pipeline/CollectionGroupOptions

CollectionGroupOptions

class CollectionGroupOptions : AbstractOptions<CollectionGroupOptions> (source)

The options of a collection group source; on Apple platforms only the forced index is supported (see CollectionSourceOptions).

Constructors

constructor()

No options.

Functions

with

fun with(key: String, value: Field): CollectionGroupOptions

A copy with the option key set to a reference to the field value. The JS SDK sends a field reference only as a nearest-neighbour search's distance field or an unnest's index field; on JS and wasmJs any other fails the execution.

fun with(key: String, value: RawOptions): CollectionGroupOptions

A copy with the option key set to the options value.

fun with(key: String, value: Boolean): CollectionGroupOptions

fun with(key: String, value: Double): CollectionGroupOptions

fun with(key: String, value: Long): CollectionGroupOptions

fun with(key: String, value: String): CollectionGroupOptions

A copy with the option key set to value.

withHints

fun withHints(hints: CollectionHints): CollectionGroupOptions

A copy with the index hints added.