A builder for generating a collection of updates to a document. Updates can be applied to either a String field or to a FieldPath. Within this builder custom serialization can be applied to the update.

FieldValue

@Serializable(with = FieldValueSerializer::class)

class FieldValue

Represents a Firebase FieldValue.

FieldValuesDSL

class FieldValuesDSL : EncodeSettings.Builder

A builder for generating the field values of a Query. The order of the field values must match the order by clauses of the Query

FieldValueSerializer

object FieldValueSerializer : KSerializer<FieldValue>

A serializer for FieldValue. Must be used in conjunction with FirebaseEncoder.

Filter

sealed class Filter

FilterBuilder

class FilterBuilder : EncodeSettings.Builder

FirebaseFirestore

class FirebaseFirestore

FirebaseFirestoreException

typealias FirebaseFirestoreException = com.google.firebase.firestore.FirebaseFirestoreException

A failed Firestore operation; the Android-SDK-shaped com.google.firebase.firestore.FirebaseFirestoreException.

FirebaseFirestoreSettings

actual data class FirebaseFirestoreSettings

expect class FirebaseFirestoreSettings

actual data class FirebaseFirestoreSettings

FirestoreExceptionCode

typealias FirestoreExceptionCode = FirebaseFirestoreException.Code

The error codes of Firestore; the Android-SDK-shaped com.google.firebase.firestore.FirebaseFirestoreException.Code.

GeoPoint

@Serializable(with = GeoPointSerializer::class)

class GeoPoint

A class representing a Firebase GeoPoint.

GeoPointSerializer

object GeoPointSerializer : KSerializer<GeoPoint>

Serializer for GeoPoint. If used with FirebaseEncoder performs serialization using native Firebase mechanisms.

LocalCacheSettings

sealed interface LocalCacheSettings

MemoryCacheSettings

typealias MemoryCacheSettings = LocalCacheSettings.Memory

MemoryEagerGcSettings

typealias MemoryEagerGcSettings = MemoryGarbageCollectorSettings.Eager

MemoryGarbageCollectorSettings

sealed interface MemoryGarbageCollectorSettings

MemoryLruGcSettings

typealias MemoryLruGcSettings = MemoryGarbageCollectorSettings.LRUGC

NativeFieldValue

typealias NativeFieldValue = FieldValue

Represents a platform specific Firebase FieldValue; the Android-SDK-shaped com.google.firebase.firestore.FieldValue.

NativeGeoPoint

typealias NativeGeoPoint = GeoPoint

A class representing a platform specific Firebase GeoPoint; the Android-SDK-shaped com.google.firebase.firestore.GeoPoint.

NativeTimestamp

typealias NativeTimestamp = Timestamp

A class representing a platform specific Firebase Timestamp; the Android-SDK-shaped com.google.firebase.Timestamp.

PersistentCacheSettings

typealias PersistentCacheSettings = LocalCacheSettings.Persistent

Query

open class Query

QuerySnapshot

class QuerySnapshot(val compat: QuerySnapshot)

ServerTimestampBehavior

enum ServerTimestampBehavior : Enum<ServerTimestampBehavior>

ServerTimestampSerializer

object ServerTimestampSerializer : KSerializer<Timestamp.ServerTimestamp>

A serializer for Timestamp.ServerTimestamp. Must be used with FirebaseEncoder/FirebaseDecoder.

SnapshotMetadata

class SnapshotMetadata(val compat: SnapshotMetadata)

Source

enum Source : Enum<Source>

Timestamp

@Serializable(with = TimestampSerializer::class)

class Timestamp : BaseTimestamp

A class representing a Firebase Timestamp.

TimestampSerializer

object TimestampSerializer : KSerializer<Timestamp>

A serializer for Timestamp. Must be used with FirebaseEncoder/FirebaseDecoder.

Transaction

data class Transaction

WhereConstraint

sealed interface WhereConstraint

WriteBatch

data class WriteBatch

Properties

android

val CollectionReference.android: CollectionReference

val DocumentChange.android: DocumentChange

val DocumentReference.android: DocumentReference

val DocumentSnapshot.android: DocumentSnapshot

val FieldPath.android: FieldPath

val FirebaseFirestore.android: FirebaseFirestore

val Query.android: Query

val QuerySnapshot.android: QuerySnapshot

val SnapshotMetadata.android: SnapshotMetadata

val Transaction.android: Transaction

val WriteBatch.android: WriteBatch

The underlying Firebase Android SDK object.

val LocalCacheSettings.android: LocalCacheSettings

The cache settings as the Firebase Android SDK's.

firestore

val Firebase.firestore: FirebaseFirestore

Returns the FirebaseFirestore instance of the default FirebaseApp.

ios

val ChangeType.ios: FIRDocumentChangeType

The change type as the Firebase iOS SDK's.

val CollectionReference.ios: FIRCollectionReference

val DocumentChange.ios: FIRDocumentChange

val DocumentReference.ios: FIRDocumentReference

val DocumentSnapshot.ios: FIRDocumentSnapshot

val FirebaseFirestore.ios: FIRFirestore

val Query.ios: FIRQuery

val QuerySnapshot.ios: FIRQuerySnapshot

val SnapshotMetadata.ios: FIRSnapshotMetadata

val Transaction.ios: FIRTransaction

val WriteBatch.ios: FIRWriteBatch

The underlying Firebase iOS SDK object.

val FieldPath.ios: FIRFieldPath

The field path as the Firebase iOS SDK's.

val LocalCacheSettings.ios: FIRLocalCacheSettingsProtocol

The cache settings as the Firebase iOS SDK's.

val CollectionReference.js: CollectionReference

val DocumentChange.js: DocumentChange

val DocumentReference.js: DocumentReference

val DocumentSnapshot.js: DocumentSnapshot

val FirebaseFirestore.js: Firestore

val Query.js: Query

val QuerySnapshot.js: QuerySnapshot

val SnapshotMetadata.js: SnapshotMetadata

val Transaction.js: Transaction

val WriteBatch.js: WriteBatch

The underlying Firebase JS SDK object.

val FieldPath.js: FieldPath

The field path as the Firebase JS SDK's.

val CollectionReference.js: CollectionReference

val DocumentChange.js: DocumentChange

val DocumentReference.js: DocumentReference

val DocumentSnapshot.js: DocumentSnapshot

val FirebaseFirestore.js: Firestore

val Query.js: Query

val QuerySnapshot.js: QuerySnapshot

val SnapshotMetadata.js: SnapshotMetadata

val Transaction.js: Transaction

val WriteBatch.js: WriteBatch

The underlying Firebase JS SDK object.

val FieldPath.js: FieldPath

The field path as the Firebase JS SDK's.

Functions

firestore

fun Firebase.firestore(app: FirebaseApp, databaseId: String? = null): FirebaseFirestore

Returns the FirebaseFirestore instance of a given FirebaseApp, and of the named database when databaseId is given.

firestoreSettings

actual fun firestoreSettings(settings: FirebaseFirestoreSettings?, builder: FirebaseFirestoreSettings.Builder.() -> Unit): FirebaseFirestoreSettings

expect fun firestoreSettings(settings: FirebaseFirestoreSettings? = null, builder: FirebaseFirestoreSettings.Builder.() -> Unit): FirebaseFirestoreSettings

actual fun firestoreSettings(settings: FirebaseFirestoreSettings?, builder: FirebaseFirestoreSettings.Builder.() -> Unit): FirebaseFirestoreSettings

fromDuration

fun Timestamp.Companion.fromDuration(duration: Duration): Timestamp

fromMilliseconds

fun Timestamp.Companion.fromMilliseconds(milliseconds: Double): Timestamp

invoke

operator fun CollectionReference.Companion.invoke(android: CollectionReference): CollectionReference

operator fun DocumentReference.Companion.invoke(android: DocumentReference): DocumentReference

operator fun DocumentSnapshot.Companion.invoke(android: DocumentSnapshot): DocumentSnapshot

operator fun FirebaseFirestore.Companion.invoke(android: FirebaseFirestore): FirebaseFirestore

operator fun Query.Companion.invoke(android: Query): Query

operator fun Transaction.Companion.invoke(android: Transaction): Transaction

operator fun WriteBatch.Companion.invoke(android: WriteBatch): WriteBatch

operator fun CollectionReference.Companion.invoke(ios: FIRCollectionReference): CollectionReference

operator fun DocumentReference.Companion.invoke(ios: FIRDocumentReference): DocumentReference

operator fun DocumentSnapshot.Companion.invoke(ios: FIRDocumentSnapshot): DocumentSnapshot

operator fun FirebaseFirestore.Companion.invoke(ios: FIRFirestore): FirebaseFirestore

operator fun Query.Companion.invoke(ios: FIRQuery): Query

operator fun Transaction.Companion.invoke(ios: FIRTransaction): Transaction

operator fun WriteBatch.Companion.invoke(ios: FIRWriteBatch): WriteBatch

operator fun CollectionReference.Companion.invoke(js: CollectionReference): CollectionReference

operator fun DocumentReference.Companion.invoke(js: DocumentReference): DocumentReference

operator fun DocumentSnapshot.Companion.invoke(js: DocumentSnapshot): DocumentSnapshot

operator fun FirebaseFirestore.Companion.invoke(js: Firestore): FirebaseFirestore

operator fun Query.Companion.invoke(js: Query): Query

operator fun Transaction.Companion.invoke(js: Transaction): Transaction

operator fun WriteBatch.Companion.invoke(js: WriteBatch): WriteBatch

operator fun CollectionReference.Companion.invoke(js: CollectionReference): CollectionReference

operator fun DocumentReference.Companion.invoke(js: DocumentReference): DocumentReference

operator fun DocumentSnapshot.Companion.invoke(js: DocumentSnapshot): DocumentSnapshot

operator fun FirebaseFirestore.Companion.invoke(js: Firestore): FirebaseFirestore

operator fun Query.Companion.invoke(js: Query): Query

operator fun Transaction.Companion.invoke(js: Transaction): Transaction

operator fun WriteBatch.Companion.invoke(js: WriteBatch): WriteBatch

memoryCacheSettings

fun memoryCacheSettings(builder: LocalCacheSettings.Memory.Builder.() -> Unit): LocalCacheSettings.Memory

memoryEagerGcSettings

fun memoryEagerGcSettings(builder: MemoryGarbageCollectorSettings.Eager.Builder.() -> Unit): MemoryGarbageCollectorSettings.Eager

memoryLruGcSettings

fun memoryLruGcSettings(builder: MemoryGarbageCollectorSettings.LRUGC.Builder.() -> Unit): MemoryGarbageCollectorSettings.LRUGC

persistentCacheSettings

fun persistentCacheSettings(builder: LocalCacheSettings.Persistent.Builder.() -> Unit): LocalCacheSettings.Persistent

toDuration

fun Timestamp.toDuration(): Duration

toException

fun NSError.toException(): FirebaseFirestoreException

The error as a FirebaseFirestoreException with the matching FirestoreExceptionCode.

toMilliseconds

fun Timestamp.toMilliseconds(): Double

where

fun Query.~~where~~(path: FieldPath, equalTo: Any?): Query

fun Query.~~where~~(field: String, equalTo: Any?): Query

fun Query.~~where~~(path: FieldPath, inArray: List<Any>? = null, arrayContainsAny: List<Any>? = null): Query

fun Query.~~where~~(field: String, inArray: List<Any>? = null, arrayContainsAny: List<Any>? = null): Query

fun Query.~~where~~(path: FieldPath, lessThan: Any? = null, greaterThan: Any? = null, arrayContains: Any? = null): Query

fun Query.~~where~~(field: String, lessThan: Any? = null, greaterThan: Any? = null, arrayContains: Any? = null): Query