firebase-firestore/com.google.firebase.firestore/Query

Query

actual open class Query(source)

A query over the documents of a collection or collection group, mirroring com.google.firebase.firestore.Query from the Firebase Android SDK: immutable, every method returns a new query with the constraint added.

Not mirrored: the Activity and Executor overloads of addSnapshotListener (see api/android-sdk/exclusions.txt).

Inheritors

actual open class Query(source)

Inheritors

expect open class Query(source)

A query over the documents of a collection or collection group, mirroring com.google.firebase.firestore.Query from the Firebase Android SDK: immutable, every method returns a new query with the constraint added.

Not mirrored: the Activity and Executor overloads of addSnapshotListener (see api/android-sdk/exclusions.txt).

Inheritors

actual open class Query(source)

Inheritors

actual open class Query(source)

Inheritors

Types

Link copied to clipboard
actual enum Direction : Enum<Query.Direction>
actual enum Direction : Enum<Query.Direction>
expect enum Direction : Enum<Query.Direction>
actual enum Direction : Enum<Query.Direction>
actual enum Direction : Enum<Query.Direction>

Properties

Link copied to clipboard
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.

Link copied to clipboard
open val ios: FIRQuery

The underlying Firebase iOS SDK object.

Link copied to clipboard
open val js: Query

The underlying Firebase JS SDK object.

open val js: Query

The underlying Firebase JS SDK object.

Functions

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun hashCode(): Int
open override fun hashCode(): Int
open override fun hashCode(): Int
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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
Link copied to clipboard
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.

Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
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.

Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
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
Generated by Dokka
firebase-multiplatform, Apache License 2.0. Based on GitLive's firebase-kotlin-sdk.