firestore

public final FirebaseFirestore firestore

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(@NonNullEventListener<QuerySnapshot> listener)

Starts listening to this query.

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(
    @NonNullActivity activity,
    @NonNullEventListener<QuerySnapshot> listener
)

Starts listening to this query using an Activity-scoped listener.

The listener will be automatically removed duringonStop.

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(
    @NonNullExecutor executor,
    @NonNullEventListener<QuerySnapshot> listener
)

Starts listening to this query.

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(
    @NonNullMetadataChanges metadataChanges,
    @NonNullEventListener<QuerySnapshot> listener
)

Starts listening to this query with the given options.

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(
    @NonNullSnapshotListenOptions options,
    @NonNullEventListener<QuerySnapshot> listener
)

Starts listening to this query with the given options.

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(
    @NonNullActivity activity,
    @NonNullMetadataChanges metadataChanges,
    @NonNullEventListener<QuerySnapshot> listener
)

Starts listening to this query with the given options, using an Activity-scoped listener.

The listener will be automatically removed duringonStop.

addSnapshotListener

public @NonNullListenerRegistration addSnapshotListener(
    @NonNullExecutor executor,
    @NonNullMetadataChanges metadataChanges,
    @NonNullEventListener<QuerySnapshot> listener
)

Starts listening to this query with the given options.

aggregate

public @NonNullAggregateQuery aggregate(
    @NonNullAggregateField aggregateField,
    @NonNull AggregateField[] aggregateFields
)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using the returned query to perform aggregations is efficient because only the final aggregation values, not the documents' data, is downloaded. The returned query can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

count

public @NonNullAggregateQuery count()

Returns a query that counts the documents in the result set of this query.

The returned query, when executed, counts the documents in the result set of this querywithout actually downloading the documents.

Using the returned query to count the documents is efficient because only the final count, not the documents' data, is downloaded. The returned query can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

endAt

public @NonNullQuery endAt(Object[] fieldValues)

Creates and returns a newQuery that ends at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

endAt

public @NonNullQuery endAt(@NonNullDocumentSnapshot snapshot)

Creates and returns a newQuery that ends at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

endBefore

public @NonNullQuery endBefore(Object[] fieldValues)

Creates and returns a newQuery that ends before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

endBefore

public @NonNullQuery endBefore(@NonNullDocumentSnapshot snapshot)

Creates and returns a newQuery that ends before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

equals

public boolean equals(Object o)

get

public @NonNullTask<QuerySnapshot> get()

Executes the query and returns the results as aQuerySnapshot.

get

public @NonNullTask<QuerySnapshot> get(@NonNullSource source)

Executes the query and returns the results as aQuerySnapshot.

By default,get() attempts to provide up-to-date data when possible by waiting for data from the server, but it may return cached data or fail if you are offline and the server cannot be reached. This behavior can be altered via theSource parameter.

getFirestore

public @NonNullFirebaseFirestore getFirestore()

Gets the Cloud Firestore instance associated with this query.

hashCode

public int hashCode()

limit

public @NonNullQuery limit(long limit)

Creates and returns a newQuery that only returns the first matching documents up to the specified number.

limitToLast

public @NonNullQuery limitToLast(long limit)

Creates and returns a newQuery that only returns the last matching documents up to the specified number.

You must specify at least oneorderBy clause forlimitToLast queries, otherwise an exception will be thrown during execution.

orderBy

public @NonNullQuery orderBy(@NonNullString field)

Creates and returns a newQuery that's additionally sorted by the specified field.

orderBy

public @NonNullQuery orderBy(@NonNullFieldPath fieldPath)

Creates and returns a newQuery that's additionally sorted by the specified field.

orderBy

public @NonNullQuery orderBy(@NonNullString field, @NonNullQuery.Direction direction)

Creates and returns a newQuery that's additionally sorted by the specified field, optionally in descending order instead of ascending.

orderBy

public @NonNullQuery orderBy(@NonNullFieldPath fieldPath, @NonNullQuery.Direction direction)

Creates and returns a newQuery that's additionally sorted by the specified field, optionally in descending order instead of ascending.

startAfter

public @NonNullQuery startAfter(Object[] fieldValues)

Creates and returns a newQuery that starts after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

startAfter

public @NonNullQuery startAfter(@NonNullDocumentSnapshot snapshot)

Creates and returns a newQuery that starts after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

startAt

public @NonNullQuery startAt(Object[] fieldValues)

Creates and returns a newQuery that starts at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

startAt

public @NonNullQuery startAt(@NonNullDocumentSnapshot snapshot)

Creates and returns a newQuery that starts at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

where

public @NonNullQuery where(@NonNullFilter filter)

Creates and returns a newQuery with the additional filter.

whereArrayContains

public @NonNullQuery whereArrayContains(@NonNullString field, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.

AQuery can have only onewhereArrayContains() filter and it cannot be combined withwhereArrayContainsAny().

whereArrayContains

public @NonNullQuery whereArrayContains(@NonNullFieldPath fieldPath, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.

AQuery can have only onewhereArrayContains() filter and it cannot be combined withwhereArrayContainsAny().

whereArrayContainsAny

public @NonNullQuery whereArrayContainsAny(@NonNullString field, @NonNullList<Object> values)

Creates and returns a newQuery with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.

AQuery can have only onewhereArrayContainsAny() filter and it cannot be combined withwhereArrayContains() orwhereIn().

whereArrayContainsAny

public @NonNullQuery whereArrayContainsAny(
    @NonNullFieldPath fieldPath,
    @NonNullList<Object> values
)

Creates and returns a newQuery with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.

AQuery can have only onewhereArrayContainsAny() filter and it cannot be combined withwhereArrayContains() orwhereIn().

whereEqualTo

public @NonNullQuery whereEqualTo(@NonNullString field, @NullableObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be equal to the specified value.

whereEqualTo

public @NonNullQuery whereEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be equal to the specified value.

whereGreaterThan

public @NonNullQuery whereGreaterThan(@NonNullString field, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be greater than the specified value.

whereGreaterThan

public @NonNullQuery whereGreaterThan(@NonNullFieldPath fieldPath, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be greater than the specified value.

whereGreaterThanOrEqualTo

public @NonNullQuery whereGreaterThanOrEqualTo(@NonNullString field, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.

whereGreaterThanOrEqualTo

public @NonNullQuery whereGreaterThanOrEqualTo(
    @NonNullFieldPath fieldPath,
    @NonNullObject value
)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.

whereIn

public @NonNullQuery whereIn(@NonNullString field, @NonNullList<Object> values)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.

AQuery can have only onewhereIn() filter, and it cannot be combined withwhereArrayContainsAny().

whereIn

public @NonNullQuery whereIn(@NonNullFieldPath fieldPath, @NonNullList<Object> values)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.

AQuery can have only onewhereIn() filter, and it cannot be combined withwhereArrayContainsAny().

whereLessThan

public @NonNullQuery whereLessThan(@NonNullString field, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be less than the specified value.

whereLessThan

public @NonNullQuery whereLessThan(@NonNullFieldPath fieldPath, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be less than the specified value.

whereLessThanOrEqualTo

public @NonNullQuery whereLessThanOrEqualTo(@NonNullString field, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be less than or equal to the specified value.

whereLessThanOrEqualTo

public @NonNullQuery whereLessThanOrEqualTo(@NonNullFieldPath fieldPath, @NonNullObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value should be less than or equal to the specified value.

whereNotEqualTo

public @NonNullQuery whereNotEqualTo(@NonNullString field, @NullableObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value does not equal the specified value.

AQuery can have only onewhereNotEqualTo() filter, and it cannot be combined withwhereNotIn().

whereNotEqualTo

public @NonNullQuery whereNotEqualTo(@NonNullFieldPath fieldPath, @NullableObject value)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value does not equal the specified value.

AQuery can have only onewhereNotEqualTo() filter, and it cannot be combined withwhereNotIn().

whereNotIn

public @NonNullQuery whereNotIn(@NonNullString field, @NonNullList<Object> values)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

One special case is thatwhereNotIn cannot matchnull values. To query for documents where a field exists and isnull, usewhereNotEqualTo, which can handle this special case.

AQuery can have only onewhereNotIn() filter, and it cannot be combined withwhereArrayContains(),whereArrayContainsAny(),whereIn(), orwhereNotEqualTo().

whereNotIn

public @NonNullQuery whereNotIn(@NonNullFieldPath fieldPath, @NonNullList<Object> values)

Creates and returns a newQuery with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

One special case is thatwhereNotIn cannot matchnull values. To query for documents where a field exists and isnull, usewhereNotEqualTo, which can handle this special case.

AQuery can have only onewhereNotIn() filter, and it cannot be combined withwhereArrayContains(),whereArrayContainsAny(),whereIn(), orwhereNotEqualTo().

FirestoreKt.dataObjects

public final @NonNullFlow<@NonNullList<@NonNull T>> <T extends Object>FirestoreKt.dataObjects(
    @NonNullQuery receiver,
    @NonNullMetadataChanges metadataChanges
)

Starts listening to this query with the given options and emits its values converted to a POJO via aFlow.

• When the returned flow starts being collected, anEventListener will be attached.

• When the flow completes, the listener will be removed.

FirestoreKt.snapshots

public final @NonNullFlow<@NonNullQuerySnapshot> FirestoreKt.snapshots(
    @NonNullQuery receiver,
    @NonNullMetadataChanges metadataChanges
)

Starts listening to this query with the given options and emits its values via aFlow.

• When the returned flow starts being collected, anEventListener will be attached.

• When the flow completes, the listener will be removed.