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

SubcollectionSource

class SubcollectionSource : Stage<SubcollectionSource> (source)

The documents of a subcollection of each input document, the source of a subquery; created with of.

Types

Companion

object Companion

Functions

withOption

fun withOption(key: String, value: Field): SubcollectionSource

A copy of this stage with the option key set to a reference to the field value. The JS SDK cannot send a field reference as an option: on JS and wasmJs, executing the pipeline fails with UnsupportedOperationException.

fun withOption(key: String, value: Boolean): SubcollectionSource

fun withOption(key: String, value: Double): SubcollectionSource

fun withOption(key: String, value: Long): SubcollectionSource

fun withOption(key: String, value: String): SubcollectionSource

A copy of this stage with the option key set to value.