firebase-firestore/com.google.firebase.firestore/CollectionReference

CollectionReference

actual class CollectionReference : Query(source)

A collection, mirroring the Android SDK's CollectionReference: a Query over its documents that can also add to it.

actual class CollectionReference : Query(source)

expect class CollectionReference : Query(source)

A collection, mirroring the Android SDK's CollectionReference: a Query over its documents that can also add to it.

actual class CollectionReference : Query(source)

Properties

firestore

actual val firestore: FirebaseFirestore

The FirebaseFirestore this query belongs to.

actual val firestore: FirebaseFirestore

The FirebaseFirestore this query belongs to.

expect val firestore: FirebaseFirestore

The FirebaseFirestore this query belongs to.

actual val firestore: FirebaseFirestore

The FirebaseFirestore this query belongs to.

actual val firestore: FirebaseFirestore

The FirebaseFirestore this query belongs to.

actual val id: String

The last segment of the path.

actual val id: String

The last segment of the path.

expect val id: String

The last segment of the path.

actual val id: String

The last segment of the path.

actual val id: String

The last segment of the path.

ios

open override val ios: FIRCollectionReference

The underlying Firebase iOS SDK object.

open override val js: CollectionReference

The underlying Firebase JS SDK object.

open override val js: CollectionReference

The underlying Firebase JS SDK object.

parent

actual val parent: DocumentReference?

The document containing this collection, or null for a root collection.

actual val parent: DocumentReference?

The document containing this collection, or null for a root collection.

expect val parent: DocumentReference?

The document containing this collection, or null for a root collection.

actual val parent: DocumentReference?

The document containing this collection, or null for a root collection.

actual val parent: DocumentReference?

The document containing this collection, or null for a root collection.

path

actual val path: String

The path from the root, /-separated.

actual val path: String

The path from the root, /-separated.

expect val path: String

The path from the root, /-separated.

actual val path: String

The path from the root, /-separated.

actual val path: String

The path from the root, /-separated.

Functions

add

actual fun add(data: Any): Task<DocumentReference>

Adds a new document with an automatically generated id and data (a map of field values).

actual fun add(data: Any): Task<DocumentReference>

Completes once the write is acknowledged, as on Android (addDocumentWithData returns the reference before that).

expect fun add(data: Any): Task<DocumentReference>

Adds a new document with an automatically generated id and data (a map of field values).

actual fun add(data: Any): Task<DocumentReference>

Adds a new document with an automatically generated id and data (a map of field values).

actual fun add(data: Any): Task<DocumentReference>

Adds a new document with an automatically generated id and data (a map of field values).

addSnapshotListener

actual fun addSnapshotListener(listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results and every change to them.

actual fun addSnapshotListener(metadataChanges: MetadataChanges, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results, also notifying listener of metadata changes when metadataChanges is INCLUDE.

actual fun addSnapshotListener(options: SnapshotListenOptions, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results with options.

fun addSnapshotListener(executor: Executor, metadataChanges: MetadataChanges, listener: EventListener<QuerySnapshot>): ListenerRegistration

Not in the common API (the executor is Android-only); the Kotlin-first layer's Android listeners bind to this member.

actual fun addSnapshotListener(listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results and every change to them.

actual fun addSnapshotListener(metadataChanges: MetadataChanges, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results, also notifying listener of metadata changes when metadataChanges is INCLUDE.

actual fun addSnapshotListener(options: SnapshotListenOptions, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results with options.

expect fun addSnapshotListener(listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results and every change to them.

expect fun addSnapshotListener(metadataChanges: MetadataChanges, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results, also notifying listener of metadata changes when metadataChanges is INCLUDE.

expect fun addSnapshotListener(options: SnapshotListenOptions, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results with options.

actual fun addSnapshotListener(listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results and every change to them.

actual fun addSnapshotListener(metadataChanges: MetadataChanges, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results, also notifying listener of metadata changes when metadataChanges is INCLUDE.

actual fun addSnapshotListener(options: SnapshotListenOptions, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results with options.

actual fun addSnapshotListener(listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results and every change to them.

actual fun addSnapshotListener(metadataChanges: MetadataChanges, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results, also notifying listener of metadata changes when metadataChanges is INCLUDE.

actual fun addSnapshotListener(options: SnapshotListenOptions, listener: EventListener<QuerySnapshot>): ListenerRegistration

Listens to the results with options.

aggregate

actual fun aggregate(aggregateField: AggregateField, vararg aggregateFields: AggregateField): AggregateQuery

An AggregateQuery computing aggregateField and aggregateFields over the results.

actual fun aggregate(aggregateField: AggregateField, vararg aggregateFields: AggregateField): AggregateQuery

An AggregateQuery computing aggregateField and aggregateFields over the results.

expect fun aggregate(aggregateField: AggregateField, vararg aggregateFields: AggregateField): AggregateQuery

An AggregateQuery computing aggregateField and aggregateFields over the results.

actual fun aggregate(aggregateField: AggregateField, vararg aggregateFields: AggregateField): AggregateQuery

An AggregateQuery computing aggregateField and aggregateFields over the results.

actual fun aggregate(aggregateField: AggregateField, vararg aggregateFields: AggregateField): AggregateQuery

An AggregateQuery computing aggregateField and aggregateFields over the results.

count

actual fun count(): AggregateQuery

An AggregateQuery counting the results.

actual fun count(): AggregateQuery

An AggregateQuery counting the results.

expect fun count(): AggregateQuery

An AggregateQuery counting the results.

actual fun count(): AggregateQuery

An AggregateQuery counting the results.

actual fun count(): AggregateQuery

An AggregateQuery counting the results.

dataObjects

inline fun <T> Query.dataObjects(metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE): Flow<List<T>>

The query results as T (see toObject) and every change to them as a Flow.

document

actual fun document(): DocumentReference

A reference to a new document with an automatically generated id.

actual fun document(documentPath: String): DocumentReference

A reference to the document at documentPath, relative to this collection.

actual fun document(): DocumentReference

A reference to a new document with an automatically generated id.

actual fun document(documentPath: String): DocumentReference

A reference to the document at documentPath, relative to this collection.

expect fun document(): DocumentReference

A reference to a new document with an automatically generated id.

expect fun document(documentPath: String): DocumentReference

A reference to the document at documentPath, relative to this collection.

actual fun document(): DocumentReference

A reference to a new document with an automatically generated id.

actual fun document(documentPath: String): DocumentReference

A reference to the document at documentPath, relative to this collection.

actual fun document(): DocumentReference

A reference to a new document with an automatically generated id.

actual fun document(documentPath: String): DocumentReference

A reference to the document at documentPath, relative to this collection.

endAt

actual fun endAt(snapshot: DocumentSnapshot): Query

actual fun endAt(vararg fieldValues: Any?): Query

actual fun endAt(snapshot: DocumentSnapshot): Query

actual fun endAt(vararg fieldValues: Any?): Query

expect fun endAt(snapshot: DocumentSnapshot): Query

expect fun endAt(vararg fieldValues: Any?): Query

actual fun endAt(snapshot: DocumentSnapshot): Query

actual fun endAt(vararg fieldValues: Any?): Query

actual fun endAt(snapshot: DocumentSnapshot): Query

actual fun endAt(vararg fieldValues: Any?): Query

endBefore

actual fun endBefore(snapshot: DocumentSnapshot): Query

actual fun endBefore(vararg fieldValues: Any?): Query

actual fun endBefore(snapshot: DocumentSnapshot): Query

actual fun endBefore(vararg fieldValues: Any?): Query

expect fun endBefore(snapshot: DocumentSnapshot): Query

expect fun endBefore(vararg fieldValues: Any?): Query

actual fun endBefore(snapshot: DocumentSnapshot): Query

actual fun endBefore(vararg fieldValues: Any?): Query

actual fun endBefore(snapshot: DocumentSnapshot): Query

actual fun endBefore(vararg fieldValues: Any?): Query

equals

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

The JS SDK creates a new object per call, so queries are equal when they describe the same collection and constraints.

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

The JS SDK creates a new object per call, so queries are equal when they describe the same collection and constraints.

get

actual fun get(): Task<QuerySnapshot>

Reads the results, from the cache and the backend as available.

actual fun get(source: Source): Task<QuerySnapshot>

Reads the results from source.

actual fun get(): Task<QuerySnapshot>

Reads the results, from the cache and the backend as available.

actual fun get(source: Source): Task<QuerySnapshot>

Reads the results from source.

expect fun get(): Task<QuerySnapshot>

Reads the results, from the cache and the backend as available.

expect fun get(source: Source): Task<QuerySnapshot>

Reads the results from source.

actual fun get(): Task<QuerySnapshot>

Reads the results, from the cache and the backend as available.

actual fun get(source: Source): Task<QuerySnapshot>

Reads the results from source.

actual fun get(): Task<QuerySnapshot>

Reads the results, from the cache and the backend as available.

actual fun get(source: Source): Task<QuerySnapshot>

Reads the results from source.

hashCode

open override fun hashCode(): Int

limit

actual fun limit(limit: Long): Query

The query limited to the first limit results.

actual fun limit(limit: Long): Query

The query limited to the first limit results.

expect fun limit(limit: Long): Query

The query limited to the first limit results.

actual fun limit(limit: Long): Query

The query limited to the first limit results.

actual fun limit(limit: Long): Query

The query limited to the first limit results.

limitToLast

actual fun limitToLast(limit: Long): Query

The query limited to the last limit results; requires an orderBy.

actual fun limitToLast(limit: Long): Query

The query limited to the last limit results; requires an orderBy.

expect fun limitToLast(limit: Long): Query

The query limited to the last limit results; requires an orderBy.

actual fun limitToLast(limit: Long): Query

The query limited to the last limit results; requires an orderBy.

actual fun limitToLast(limit: Long): Query

The query limited to the last limit results; requires an orderBy.

orderBy

actual fun orderBy(fieldPath: FieldPath): Query

actual fun orderBy(field: String): Query

actual fun orderBy(fieldPath: FieldPath, direction: Query.Direction): Query

actual fun orderBy(field: String, direction: Query.Direction): Query

actual fun orderBy(fieldPath: FieldPath): Query

actual fun orderBy(field: String): Query

actual fun orderBy(fieldPath: FieldPath, direction: Query.Direction): Query

actual fun orderBy(field: String, direction: Query.Direction): Query

expect fun orderBy(fieldPath: FieldPath): Query

expect fun orderBy(field: String): Query

expect fun orderBy(fieldPath: FieldPath, direction: Query.Direction): Query

expect fun orderBy(field: String, direction: Query.Direction): Query

actual fun orderBy(fieldPath: FieldPath): Query

actual fun orderBy(field: String): Query

actual fun orderBy(fieldPath: FieldPath, direction: Query.Direction): Query

actual fun orderBy(field: String, direction: Query.Direction): Query

actual fun orderBy(fieldPath: FieldPath): Query

actual fun orderBy(field: String): Query

actual fun orderBy(fieldPath: FieldPath, direction: Query.Direction): Query

actual fun orderBy(field: String, direction: Query.Direction): Query

snapshots

fun Query.snapshots(metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE): Flow<QuerySnapshot>

The query results and every change to them as a Flow, which fails if the listener fails.

startAfter

actual fun startAfter(snapshot: DocumentSnapshot): Query

actual fun startAfter(vararg fieldValues: Any?): Query

actual fun startAfter(snapshot: DocumentSnapshot): Query

actual fun startAfter(vararg fieldValues: Any?): Query

expect fun startAfter(snapshot: DocumentSnapshot): Query

expect fun startAfter(vararg fieldValues: Any?): Query

actual fun startAfter(snapshot: DocumentSnapshot): Query

actual fun startAfter(vararg fieldValues: Any?): Query

actual fun startAfter(snapshot: DocumentSnapshot): Query

actual fun startAfter(vararg fieldValues: Any?): Query

startAt

actual fun startAt(snapshot: DocumentSnapshot): Query

actual fun startAt(vararg fieldValues: Any?): Query

actual fun startAt(snapshot: DocumentSnapshot): Query

actual fun startAt(vararg fieldValues: Any?): Query

expect fun startAt(snapshot: DocumentSnapshot): Query

expect fun startAt(vararg fieldValues: Any?): Query

actual fun startAt(snapshot: DocumentSnapshot): Query

actual fun startAt(vararg fieldValues: Any?): Query

actual fun startAt(snapshot: DocumentSnapshot): Query

actual fun startAt(vararg fieldValues: Any?): Query

toString

open override fun toString(): String

where

actual fun where(filter: Filter): Query

The query with filter added, which may combine conditions with Filter.and and Filter.or.

actual fun where(filter: Filter): Query

The query with filter added, which may combine conditions with Filter.and and Filter.or.

expect fun where(filter: Filter): Query

The query with filter added, which may combine conditions with Filter.and and Filter.or.

actual fun where(filter: Filter): Query

The query with filter added, which may combine conditions with Filter.and and Filter.or.

actual fun where(filter: Filter): Query

The query with filter added, which may combine conditions with Filter.and and Filter.or.

whereArrayContains

actual fun whereArrayContains(fieldPath: FieldPath, value: Any): Query

actual fun whereArrayContains(field: String, value: Any): Query

actual fun whereArrayContains(fieldPath: FieldPath, value: Any): Query

actual fun whereArrayContains(field: String, value: Any): Query

expect fun whereArrayContains(fieldPath: FieldPath, value: Any): Query

expect fun whereArrayContains(field: String, value: Any): Query

actual fun whereArrayContains(fieldPath: FieldPath, value: Any): Query

actual fun whereArrayContains(field: String, value: Any): Query

actual fun whereArrayContains(fieldPath: FieldPath, value: Any): Query

actual fun whereArrayContains(field: String, value: Any): Query

whereArrayContainsAny

actual fun whereArrayContainsAny(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereArrayContainsAny(field: String, values: List<Any>): Query

actual fun whereArrayContainsAny(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereArrayContainsAny(field: String, values: List<Any>): Query

expect fun whereArrayContainsAny(fieldPath: FieldPath, values: List<Any>): Query

expect fun whereArrayContainsAny(field: String, values: List<Any>): Query

actual fun whereArrayContainsAny(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereArrayContainsAny(field: String, values: List<Any>): Query

actual fun whereArrayContainsAny(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereArrayContainsAny(field: String, values: List<Any>): Query

whereEqualTo

actual fun whereEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereEqualTo(field: String, value: Any?): Query

actual fun whereEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereEqualTo(field: String, value: Any?): Query

expect fun whereEqualTo(fieldPath: FieldPath, value: Any?): Query

expect fun whereEqualTo(field: String, value: Any?): Query

actual fun whereEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereEqualTo(field: String, value: Any?): Query

actual fun whereEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereEqualTo(field: String, value: Any?): Query

whereGreaterThan

actual fun whereGreaterThan(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThan(field: String, value: Any): Query

actual fun whereGreaterThan(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThan(field: String, value: Any): Query

expect fun whereGreaterThan(fieldPath: FieldPath, value: Any): Query

expect fun whereGreaterThan(field: String, value: Any): Query

actual fun whereGreaterThan(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThan(field: String, value: Any): Query

actual fun whereGreaterThan(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThan(field: String, value: Any): Query

whereGreaterThanOrEqualTo

actual fun whereGreaterThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThanOrEqualTo(field: String, value: Any): Query

actual fun whereGreaterThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThanOrEqualTo(field: String, value: Any): Query

expect fun whereGreaterThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

expect fun whereGreaterThanOrEqualTo(field: String, value: Any): Query

actual fun whereGreaterThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThanOrEqualTo(field: String, value: Any): Query

actual fun whereGreaterThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereGreaterThanOrEqualTo(field: String, value: Any): Query

whereIn

actual fun whereIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereIn(field: String, values: List<Any>): Query

actual fun whereIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereIn(field: String, values: List<Any>): Query

expect fun whereIn(fieldPath: FieldPath, values: List<Any>): Query

expect fun whereIn(field: String, values: List<Any>): Query

actual fun whereIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereIn(field: String, values: List<Any>): Query

actual fun whereIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereIn(field: String, values: List<Any>): Query

whereLessThan

actual fun whereLessThan(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThan(field: String, value: Any): Query

actual fun whereLessThan(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThan(field: String, value: Any): Query

expect fun whereLessThan(fieldPath: FieldPath, value: Any): Query

expect fun whereLessThan(field: String, value: Any): Query

actual fun whereLessThan(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThan(field: String, value: Any): Query

actual fun whereLessThan(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThan(field: String, value: Any): Query

whereLessThanOrEqualTo

actual fun whereLessThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThanOrEqualTo(field: String, value: Any): Query

actual fun whereLessThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThanOrEqualTo(field: String, value: Any): Query

expect fun whereLessThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

expect fun whereLessThanOrEqualTo(field: String, value: Any): Query

actual fun whereLessThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThanOrEqualTo(field: String, value: Any): Query

actual fun whereLessThanOrEqualTo(fieldPath: FieldPath, value: Any): Query

actual fun whereLessThanOrEqualTo(field: String, value: Any): Query

whereNotEqualTo

actual fun whereNotEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereNotEqualTo(field: String, value: Any?): Query

actual fun whereNotEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereNotEqualTo(field: String, value: Any?): Query

expect fun whereNotEqualTo(fieldPath: FieldPath, value: Any?): Query

expect fun whereNotEqualTo(field: String, value: Any?): Query

actual fun whereNotEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereNotEqualTo(field: String, value: Any?): Query

actual fun whereNotEqualTo(fieldPath: FieldPath, value: Any?): Query

actual fun whereNotEqualTo(field: String, value: Any?): Query

whereNotIn

actual fun whereNotIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereNotIn(field: String, values: List<Any>): Query

actual fun whereNotIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereNotIn(field: String, values: List<Any>): Query

expect fun whereNotIn(fieldPath: FieldPath, values: List<Any>): Query

expect fun whereNotIn(field: String, values: List<Any>): Query

actual fun whereNotIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereNotIn(field: String, values: List<Any>): Query

actual fun whereNotIn(fieldPath: FieldPath, values: List<Any>): Query

actual fun whereNotIn(field: String, values: List<Any>): Query