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

CollectionGroupSource

class CollectionGroupSource : Stage<CollectionGroupSource> (source)

The documents of every collection with an id, the source of com.google.firebase.firestore.PipelineSource.collectionGroup.

Properties

collectionId

val collectionId: String

The id of the collections.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

withOption

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

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): CollectionGroupSource

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

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

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

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