firebase-firestore/com.google.firebase.firestore

Package-level declarations

Types

actual abstract class AggregateField

An aggregation of a field, mirroring the Android SDK's AggregateField; created with count, sum and average.

expect abstract class AggregateField

An aggregation of a field, mirroring the Android SDK's AggregateField; created with count, sum and average.

actual abstract class AggregateField

actual class AggregateQuery

An aggregation over the results of a Query, mirroring the Android SDK's AggregateQuery.

actual class AggregateQuery

An aggregation over the results of a Query, mirroring the Android SDK's AggregateQuery.

expect class AggregateQuery

An aggregation over the results of a Query, mirroring the Android SDK's AggregateQuery.

actual class AggregateQuery

An aggregation over the results of a Query, mirroring the Android SDK's AggregateQuery.

actual class AggregateQuery

An aggregation over the results of a Query, mirroring the Android SDK's AggregateQuery.

AggregateQuerySnapshot

actual class AggregateQuerySnapshot

The results of an AggregateQuery, mirroring the Android SDK's AggregateQuerySnapshot.

expect class AggregateQuerySnapshot

The results of an AggregateQuery, mirroring the Android SDK's AggregateQuerySnapshot.

actual class AggregateQuerySnapshot

AggregateSource

enum AggregateSource : Enum<AggregateSource>

Where an aggregation is computed.

class Blob : Comparable<Blob>

Binary data stored in a document, mirroring com.google.firebase.firestore.Blob from the Firebase Android SDK: plain bytes, or BSON binary data with a subType. A blob of subtype 0 is stored as plain bytes, as the SDKs do.

class BsonObjectId(val value: String)

A BSON ObjectId, mirroring com.google.firebase.firestore.BsonObjectId from the Firebase Android SDK.

class BsonTimestamp(val seconds: Long, val increment: Long)

A BSON Timestamp, mirroring com.google.firebase.firestore.BsonTimestamp from the Firebase Android SDK.

CollectionReference

actual class CollectionReference : Query

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

actual class CollectionReference : Query

expect class CollectionReference : Query

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

actual class CollectionReference : Query

actual class CollectionReference : Query

Decimal128Value

class Decimal128Value(val stringValue: String)

A 128-bit decimal, mirroring com.google.firebase.firestore.Decimal128Value from the Firebase Android SDK. Values are equal when they are numerically equal (1.0 and 1, 0 and -0, NaN and NaN), as on Android, where the SDK compares them as 128-bit binary floating-point numbers; here they are compared exactly as decimals, which differs only for values beyond that precision or range.

actual class DocumentChange

A change to the results of a query, mirroring the Android SDK's DocumentChange.

actual class DocumentChange

expect class DocumentChange

A change to the results of a query, mirroring the Android SDK's DocumentChange.

actual class DocumentChange

actual class DocumentChange

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class DocumentId

Marks a property that receives the document id when a document is mapped to a custom class on Android.

DocumentReference

actual class DocumentReference

A document location, mirroring com.google.firebase.firestore.DocumentReference from the Firebase Android SDK: the document may or may not exist; reads, writes and listeners are performed through it. Data is written as maps of field values (a custom class is only mapped by reflection on Android).

actual class DocumentReference

expect class DocumentReference

A document location, mirroring com.google.firebase.firestore.DocumentReference from the Firebase Android SDK: the document may or may not exist; reads, writes and listeners are performed through it. Data is written as maps of field values (a custom class is only mapped by reflection on Android).

actual class DocumentReference

actual class DocumentReference

DocumentSnapshot

actual open class DocumentSnapshot

The data of a document read from Firestore, mirroring com.google.firebase.firestore.DocumentSnapshot from the Firebase Android SDK. Field values are the Firestore types: Boolean, Long, Double, String, Timestamp, GeoPoint, Blob, DocumentReference, VectorValue, List and Map, and the BSON types BsonObjectId, BsonTimestamp, Decimal128Value, Int32Value, MaxKey, MinKey and RegexValue, as on Android; a document that does not exist has no data.

actual open class DocumentSnapshot

expect open class DocumentSnapshot

The data of a document read from Firestore, mirroring com.google.firebase.firestore.DocumentSnapshot from the Firebase Android SDK. Field values are the Firestore types: Boolean, Long, Double, String, Timestamp, GeoPoint, Blob, DocumentReference, VectorValue, List and Map, and the BSON types BsonObjectId, BsonTimestamp, Decimal128Value, Int32Value, MaxKey, MinKey and RegexValue, as on Android; a document that does not exist has no data.

actual open class DocumentSnapshot

actual open class DocumentSnapshot

fun interface EventListener<T>

Receives the snapshots of a document or query, or the error that ended the listener.

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class Exclude

Excludes a property from the reflective mapping on Android.

actual class FieldPath

A path to a field of a document, mirroring com.google.firebase.firestore.FieldPath from the Firebase Android SDK.

expect class FieldPath

A path to a field of a document, mirroring com.google.firebase.firestore.FieldPath from the Firebase Android SDK.

actual class FieldPath

actual abstract class FieldValue

A sentinel written in place of a field value, mirroring com.google.firebase.firestore.FieldValue from the Firebase Android SDK: a server timestamp, a deletion or a transform of the current value. It also creates VectorValues.

expect abstract class FieldValue

A sentinel written in place of a field value, mirroring com.google.firebase.firestore.FieldValue from the Firebase Android SDK: a server timestamp, a deletion or a transform of the current value. It also creates VectorValues.

actual abstract class FieldValue

A sentinel value; operation and arguments are converted to the platform SDK's field value when written.

actual class Filter

A query condition, mirroring com.google.firebase.firestore.Filter from the Firebase Android SDK: field conditions combined with and and or, applied with Query.where.

expect class Filter

A query condition, mirroring com.google.firebase.firestore.Filter from the Firebase Android SDK: field conditions combined with and and or, applied with Query.where.

actual class Filter

A condition tree; node is null for the empty filter of the public constructor, which matches everything.

FirebaseFirestore

actual class FirebaseFirestore

The entry point of Cloud Firestore, mirroring com.google.firebase.firestore.FirebaseFirestore from the Firebase Android SDK: obtained per FirebaseApp and database with the static accessors (or the Firebase.firestore extensions), it creates references, batches and transactions and manages the network and the local cache.

actual class FirebaseFirestore

expect class FirebaseFirestore

The entry point of Cloud Firestore, mirroring com.google.firebase.firestore.FirebaseFirestore from the Firebase Android SDK: obtained per FirebaseApp and database with the static accessors (or the Firebase.firestore extensions), it creates references, batches and transactions and manages the network and the local cache.

actual class FirebaseFirestore

The JS SDK's Firestore must be initialised with its settings (and connected to the emulator) before any use, so the underlying object is created on first use with the settings set until then, as the Android SDK's semantics require. Instances are cached per app and database, as the Android SDK's getInstance.

actual class FirebaseFirestore

The JS SDK's Firestore must be initialised with its settings (and connected to the emulator) before any use, so the underlying object is created on first use with the settings set until then, as the Android SDK's semantics require. Instances are cached per app and database, as the Android SDK's getInstance.

FirebaseFirestoreException

class FirebaseFirestoreException : FirebaseException

A failed Firestore operation, mirroring com.google.firebase.firestore.FirebaseFirestoreException from the Firebase Android SDK; code is the gRPC-style Code of the failure.

FirebaseFirestoreSettings

actual class FirebaseFirestoreSettings

The settings of a FirebaseFirestore, mirroring com.google.firebase.firestore.FirebaseFirestoreSettings from the Firebase Android SDK: built with Builder (or the firestoreSettings extension) and applied with FirebaseFirestore.firestoreSettings before the instance is used.

expect class FirebaseFirestoreSettings

The settings of a FirebaseFirestore, mirroring com.google.firebase.firestore.FirebaseFirestoreSettings from the Firebase Android SDK: built with Builder (or the firestoreSettings extension) and applied with FirebaseFirestore.firestoreSettings before the instance is used.

actual class FirebaseFirestoreSettings

The settings of a FirebaseFirestore, mirroring com.google.firebase.firestore.FirebaseFirestoreSettings from the Firebase Android SDK: built with Builder (or the firestoreSettings extension) and applied with FirebaseFirestore.firestoreSettings before the instance is used.

class GeoPoint(val latitude: Double, val longitude: Double) : Comparable<GeoPoint>

A geographical point, mirroring com.google.firebase.firestore.GeoPoint from the Firebase Android SDK.

IgnoreExtraProperties

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IgnoreExtraProperties

Ignores document fields without a matching property in the reflective mapping on Android.

class Int32Value(val value: Int)

A 32-bit integer, stored as such rather than as Firestore's 64-bit integer, mirroring com.google.firebase.firestore.Int32Value from the Firebase Android SDK.

ListenerRegistration

fun interface ListenerRegistration

A registered snapshot listener; remove stops it.

enum ListenSource : Enum<ListenSource>

Where a snapshot listener listens: the default (cache then backend) or the local cache only.

actual abstract class LoadBundleTask : Task<LoadBundleTaskProgress>

The loading of a bundle, mirroring the Android SDK's LoadBundleTask: a Task of the final LoadBundleTaskProgress that also reports intermediate progress to addOnProgressListener. Only created by FirebaseFirestore.loadBundle.

expect abstract class LoadBundleTask : Task<LoadBundleTaskProgress>

The loading of a bundle, mirroring the Android SDK's LoadBundleTask: a Task of the final LoadBundleTaskProgress that also reports intermediate progress to addOnProgressListener. Only created by FirebaseFirestore.loadBundle.

actual abstract class LoadBundleTask : Task<LoadBundleTaskProgress>

Created by the platform implementations of FirebaseFirestore.loadBundle as a LoadBundleTaskImpl.

LoadBundleTaskProgress

actual class LoadBundleTaskProgress

The progress of a LoadBundleTask.

expect class LoadBundleTaskProgress

The progress of a LoadBundleTask.

actual class LoadBundleTaskProgress

The progress of a LoadBundleTask.

LocalCacheSettings

interface LocalCacheSettings

The configuration of the local cache: PersistentCacheSettings or MemoryCacheSettings.

class MaxKey

The BSON MaxKey, which orders after every other value, mirroring com.google.firebase.firestore.MaxKey from the Firebase Android SDK.

MemoryCacheSettings

actual class MemoryCacheSettings : LocalCacheSettings

An in-memory local cache, mirroring the Android SDK's MemoryCacheSettings; built with newBuilder.

expect class MemoryCacheSettings : LocalCacheSettings

An in-memory local cache, mirroring the Android SDK's MemoryCacheSettings; built with newBuilder.

actual class MemoryCacheSettings : LocalCacheSettings

An in-memory local cache, mirroring the Android SDK's MemoryCacheSettings; built with newBuilder.

MemoryEagerGcSettings

actual class MemoryEagerGcSettings : MemoryGarbageCollectorSettings

Eager garbage collection: documents are dropped as soon as no listener uses them; the Android SDK's MemoryEagerGcSettings.

expect class MemoryEagerGcSettings : MemoryGarbageCollectorSettings

Eager garbage collection: documents are dropped as soon as no listener uses them; the Android SDK's MemoryEagerGcSettings.

actual class MemoryEagerGcSettings : MemoryGarbageCollectorSettings

Eager garbage collection: documents are dropped as soon as no listener uses them; the Android SDK's MemoryEagerGcSettings.

MemoryGarbageCollectorSettings

interface MemoryGarbageCollectorSettings

How an in-memory cache is garbage collected: MemoryEagerGcSettings or MemoryLruGcSettings.

MemoryLruGcSettings

actual class MemoryLruGcSettings : MemoryGarbageCollectorSettings

Least-recently-used garbage collection up to a size, the Android SDK's MemoryLruGcSettings.

expect class MemoryLruGcSettings : MemoryGarbageCollectorSettings

Least-recently-used garbage collection up to a size, the Android SDK's MemoryLruGcSettings.

actual class MemoryLruGcSettings : MemoryGarbageCollectorSettings

Least-recently-used garbage collection up to a size, the Android SDK's MemoryLruGcSettings.

MetadataChanges

enum MetadataChanges : Enum<MetadataChanges>

Whether snapshot listeners are notified of metadata-only changes.

class MinKey

The BSON MinKey, which orders before every other value, mirroring com.google.firebase.firestore.MinKey from the Firebase Android SDK.

OnProgressListener

fun interface OnProgressListener<ProgressT>

Receives the progress of a LoadBundleTask.

PersistentCacheIndexManager

actual class PersistentCacheIndexManager

Manages the indexes of the persistent cache, mirroring the Android SDK's PersistentCacheIndexManager.

actual class PersistentCacheIndexManager

expect class PersistentCacheIndexManager

Manages the indexes of the persistent cache, mirroring the Android SDK's PersistentCacheIndexManager.

actual class PersistentCacheIndexManager

actual class PersistentCacheIndexManager

PersistentCacheSettings

actual class PersistentCacheSettings : LocalCacheSettings

A persistent (on-disk) local cache, mirroring the Android SDK's PersistentCacheSettings; built with newBuilder.

expect class PersistentCacheSettings : LocalCacheSettings

A persistent (on-disk) local cache, mirroring the Android SDK's PersistentCacheSettings; built with newBuilder.

actual class PersistentCacheSettings : LocalCacheSettings

A persistent (on-disk) local cache, mirroring the Android SDK's PersistentCacheSettings; built with newBuilder.

A pipeline: a source (from FirebaseFirestore.pipeline) followed by stages that filter, transform and aggregate the documents, run by execute. Immutable: each stage method returns a new pipeline with the stage appended.

class PipelineResult

A result of a Pipeline: a document of the last stage, with its fields and, for a stored document, its reference.

class PipelineSource

The sources of the pipelines of a FirebaseFirestore, from FirebaseFirestore.pipeline.

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class PropertyName(val value: String)

The document field name of a property in the reflective mapping on Android.

actual open class Query

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.

actual open class Query

expect open class Query

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.

actual open class Query

actual open class Query

QueryDocumentSnapshot

actual class QueryDocumentSnapshot : DocumentSnapshot

A DocumentSnapshot from a query, which is guaranteed to exist.

actual class QueryDocumentSnapshot : DocumentSnapshot

expect class QueryDocumentSnapshot : DocumentSnapshot

A DocumentSnapshot from a query, which is guaranteed to exist.

actual class QueryDocumentSnapshot : DocumentSnapshot

actual class QueryDocumentSnapshot : DocumentSnapshot

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot>

The results of a Query, mirroring the Android SDK's QuerySnapshot: the documents and the changes since the previous snapshot.

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot>

expect class QuerySnapshot : Iterable<QueryDocumentSnapshot>

The results of a Query, mirroring the Android SDK's QuerySnapshot: the documents and the changes since the previous snapshot.

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot>

actual class QuerySnapshot : Iterable<QueryDocumentSnapshot>

class RegexValue(val pattern: String, val options: String)

A BSON regular expression, mirroring com.google.firebase.firestore.RegexValue from the Firebase Android SDK.

ServerTimestamp

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER])

annotation class ServerTimestamp

Marks a property populated with the server timestamp in the reflective mapping on Android.

actual class SetOptions

How a set merges with an existing document, mirroring com.google.firebase.firestore.SetOptions from the Firebase Android SDK.

expect class SetOptions

How a set merges with an existing document, mirroring com.google.firebase.firestore.SetOptions from the Firebase Android SDK.

actual class SetOptions

SnapshotListenOptions

class SnapshotListenOptions

The options of a snapshot listener, mirroring the Android SDK's SnapshotListenOptions.

SnapshotMetadata

actual class SnapshotMetadata

The metadata of a snapshot, mirroring the Android SDK's SnapshotMetadata.

actual class SnapshotMetadata

expect class SnapshotMetadata

The metadata of a snapshot, mirroring the Android SDK's SnapshotMetadata.

actual class SnapshotMetadata

actual class SnapshotMetadata

enum Source : Enum<Source>

Where a one-time read reads from.

ThrowOnExtraProperties

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ThrowOnExtraProperties

Fails the reflective mapping on Android for document fields without a matching property.

actual class Transaction

A transaction, mirroring com.google.firebase.firestore.Transaction from the Firebase Android SDK: the writes are applied atomically when the Function returns. Reads inside a transaction (get) are synchronous on Android, the JVM and Apple platforms and are declared in the nonJs source set, as the JS SDK only reads asynchronously.

actual class Transaction

expect class Transaction

A transaction, mirroring com.google.firebase.firestore.Transaction from the Firebase Android SDK: the writes are applied atomically when the Function returns. Reads inside a transaction (get) are synchronous on Android, the JVM and Apple platforms and are declared in the nonJs source set, as the JS SDK only reads asynchronously.

actual class Transaction

actual class Transaction

TransactionOptions

class TransactionOptions

The options of a transaction, mirroring the Android SDK's TransactionOptions.

actual class VectorValue

A vector of doubles stored in a document, such as an embedding for vector search, mirroring com.google.firebase.firestore.VectorValue from the Firebase Android SDK; FieldValue.vector creates one. Vectors are equal when their values are, compared as DoubleArray.contentEquals does (NaN equals itself, 0.0 and -0.0 differ), as on Android.

expect class VectorValue

A vector of doubles stored in a document, such as an embedding for vector search, mirroring com.google.firebase.firestore.VectorValue from the Firebase Android SDK; FieldValue.vector creates one. Vectors are equal when their values are, compared as DoubleArray.contentEquals does (NaN equals itself, 0.0 and -0.0 differ), as on Android.

actual class VectorValue

A copy of values; converted to the platform SDK's vector value when written.

actual class WriteBatch

A batch of writes, mirroring com.google.firebase.firestore.WriteBatch from the Firebase Android SDK: applied atomically by commit.

actual class WriteBatch

expect class WriteBatch

A batch of writes, mirroring com.google.firebase.firestore.WriteBatch from the Firebase Android SDK: applied atomically by commit.

actual class WriteBatch

actual class WriteBatch

Properties

val Firebase.firestore: FirebaseFirestore

The FirebaseFirestore of the default FirebaseApp; the Android SDK's Firebase.firestore.

Functions

inline fun <T> DocumentReference.dataObjects(metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE): Flow<T?>

The document data as T (see toObject) and every change to it as a Flow.

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.

fun Firebase.firestore(app: FirebaseApp): FirebaseFirestore

The FirebaseFirestore of app.

fun Firebase.firestore(database: String): FirebaseFirestore

The FirebaseFirestore of the default FirebaseApp for the named database.

fun Firebase.firestore(app: FirebaseApp, database: String): FirebaseFirestore

The FirebaseFirestore of app for the named database.

firestoreSettings

fun firestoreSettings(init: FirebaseFirestoreSettings.Builder.() -> Unit): FirebaseFirestoreSettings

FirebaseFirestoreSettings built with init, as the Android SDK's firestoreSettings.

inline fun <T> DocumentSnapshot.getField(fieldPath: FieldPath): T?

inline fun <T> DocumentSnapshot.getField(fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T?

The value of fieldPath as T; on Apple platforms and JS a cast of DocumentSnapshot.get.

inline fun <T> DocumentSnapshot.getField(field: String): T?

inline fun <T> DocumentSnapshot.getField(field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T?

The value of field as T; on Apple platforms and JS a cast of DocumentSnapshot.get.

memoryCacheSettings

fun memoryCacheSettings(init: MemoryCacheSettings.Builder.() -> Unit): MemoryCacheSettings

MemoryCacheSettings built with init, as the Android SDK's memoryCacheSettings.

memoryEagerGcSettings

fun memoryEagerGcSettings(init: MemoryEagerGcSettings.Builder.() -> Unit): MemoryEagerGcSettings

MemoryEagerGcSettings built with init, as the Android SDK's memoryEagerGcSettings.

memoryLruGcSettings

fun memoryLruGcSettings(init: MemoryLruGcSettings.Builder.() -> Unit): MemoryLruGcSettings

MemoryLruGcSettings built with init, as the Android SDK's memoryLruGcSettings.

persistentCacheSettings

fun persistentCacheSettings(init: PersistentCacheSettings.Builder.() -> Unit): PersistentCacheSettings

PersistentCacheSettings built with init, as the Android SDK's persistentCacheSettings.

fun DocumentReference.snapshots(metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE): Flow<DocumentSnapshot>

The document and every change to it as a Flow, which fails if the listener fails.

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.

inline fun <T> DocumentSnapshot.toObject(): T?

inline fun <T> QueryDocumentSnapshot.toObject(): T

The document as T; on Apple platforms and JS a cast of DocumentSnapshot.data.

inline fun <T> DocumentSnapshot.toObject(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T?

inline fun <T> QueryDocumentSnapshot.toObject(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): T

The document as T; on Apple platforms and JS a cast of DocumentSnapshot.getData.

inline fun <T> QuerySnapshot.toObjects(): List<T>

The documents as T; on Apple platforms and JS casts of DocumentSnapshot.data.

inline fun <T> QuerySnapshot.toObjects(serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior): List<T>

The documents as T; on Apple platforms and JS casts of DocumentSnapshot.getData.