Package-level declarations

Types

Link copied to clipboard
@Serializable(with = BaseTimestampSerializer::class)
actual sealed class BaseTimestamp

A base class that could be used to combine Timestamp and Timestamp.ServerTimestamp in the same field.

@Serializable(with = BaseTimestampSerializer::class)
expect sealed class BaseTimestamp

A base class that could be used to combine Timestamp and Timestamp.ServerTimestamp in the same field.

@Serializable(with = BaseTimestampSerializer::class)
actual sealed class BaseTimestamp

A base class that could be used to combine Timestamp and Timestamp.ServerTimestamp in the same field.

@Serializable(with = BaseTimestampSerializer::class)
actual sealed class BaseTimestamp

A base class that could be used to combine Timestamp and Timestamp.ServerTimestamp in the same field.

@Serializable(with = BaseTimestampSerializer::class)
actual sealed class BaseTimestamp

A base class that could be used to combine Timestamp and Timestamp.ServerTimestamp in the same field.

Link copied to clipboard
object BaseTimestampSerializer : KSerializer<BaseTimestamp>

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

Link copied to clipboard
actual typealias ChangeType = DocumentChange.Type
expect enum ChangeType : Enum<ChangeType>
actual enum ChangeType : Enum<ChangeType>
actual enum ChangeType : Enum<ChangeType>
actual typealias ChangeType = DocumentChange.Type
Link copied to clipboard
Link copied to clipboard
actual typealias Direction = Query.Direction
expect enum Direction : Enum<Direction>
actual enum Direction : Enum<Direction>
actual enum Direction : Enum<Direction>
actual typealias Direction = Query.Direction
Link copied to clipboard
actual class DocumentChange
expect class DocumentChange
actual class DocumentChange
actual class DocumentChange
actual class DocumentChange
Link copied to clipboard

A class representing a Firebase DocumentReference.

Link copied to clipboard

A serializer for DocumentReference. If used with FirebaseEncoder performs serialization using native Firebase mechanisms.

Link copied to clipboard
data class DocumentSnapshot
Link copied to clipboard
object DoubleAsTimestampSerializer : KSerializer<Double>

A serializer for a Double field which is stored as a Timestamp.

Link copied to clipboard
actual typealias EncodedFieldPath = FieldPath
expect class EncodedFieldPath
actual typealias EncodedFieldPath = FIRFieldPath
actual typealias EncodedFieldPath = FieldPath
actual typealias EncodedFieldPath = FieldPath
Link copied to clipboard
actual class FieldPath(fieldNames: String)
expect class FieldPath(fieldNames: String)
actual class FieldPath(fieldNames: String)
actual class FieldPath(fieldNames: String)
actual class FieldPath(fieldNames: String)
Link copied to clipboard
@Serializable(with = FieldValueSerializer::class)
actual class FieldValue

Represents a Firebase FieldValue.

@Serializable(with = FieldValueSerializer::class)
expect class FieldValue

Represents a Firebase FieldValue.

@Serializable(with = FieldValueSerializer::class)
actual class FieldValue

Represents a Firebase FieldValue.

@Serializable(with = FieldValueSerializer::class)
actual class FieldValue

Represents a Firebase FieldValue.

@Serializable(with = FieldValueSerializer::class)
actual class FieldValue

Represents a Firebase FieldValue.

Link copied to clipboard
object FieldValueSerializer : KSerializer<FieldValue>

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

Link copied to clipboard
sealed class Filter
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual typealias FirebaseFirestoreException = com.google.firebase.firestore.FirebaseFirestoreException
actual typealias FirebaseFirestoreException = com.google.firebase.firestore.FirebaseFirestoreException
Link copied to clipboard
actual data class FirebaseFirestoreSettings
actual data class FirebaseFirestoreSettings
actual data class FirebaseFirestoreSettings
actual data class FirebaseFirestoreSettings
Link copied to clipboard
actual typealias FirestoreExceptionCode = FirebaseFirestoreException.Code
actual typealias FirestoreExceptionCode = FirebaseFirestoreException.Code
Link copied to clipboard
@Serializable(with = GeoPointSerializer::class)
actual class GeoPoint

A class representing a Firebase GeoPoint.

@Serializable(with = GeoPointSerializer::class)
expect class GeoPoint

A class representing a Firebase GeoPoint.

@Serializable(with = GeoPointSerializer::class)
actual class GeoPoint

A class representing a Firebase GeoPoint.

@Serializable(with = GeoPointSerializer::class)
actual class GeoPoint

A class representing a Firebase GeoPoint.

@Serializable(with = GeoPointSerializer::class)
actual class GeoPoint

A class representing a Firebase GeoPoint.

Link copied to clipboard
object GeoPointSerializer : KSerializer<GeoPoint>

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

Link copied to clipboard
sealed interface LocalCacheSettings
Link copied to clipboard
Link copied to clipboard
typealias NativeFieldValue = FieldValue

Represents a platform specific Firebase FieldValue.

typealias NativeFieldValue = FieldValue

Represents a platform specific Firebase FieldValue.

typealias NativeFieldValue = FieldValue

Represents a platform specific Firebase FieldValue.

Link copied to clipboard
actual typealias NativeGeoPoint = GeoPoint

A class representing a platform specific Firebase GeoPoint.

expect class NativeGeoPoint

A class representing a platform specific Firebase GeoPoint.

actual typealias NativeGeoPoint = FIRGeoPoint

A class representing a platform specific Firebase GeoPoint.

actual typealias NativeGeoPoint = GeoPoint

A class representing a platform specific Firebase GeoPoint.

actual typealias NativeGeoPoint = GeoPoint

A class representing a platform specific Firebase GeoPoint.

Link copied to clipboard
actual typealias NativeTimestamp = Timestamp

A class representing a platform specific Firebase Timestamp.

expect class NativeTimestamp

A class representing a platform specific Firebase Timestamp.

actual typealias NativeTimestamp = FIRTimestamp

A class representing a platform specific Firebase Timestamp.

actual typealias NativeTimestamp = Timestamp

A class representing a platform specific Firebase Timestamp.

actual typealias NativeTimestamp = Timestamp

A class representing a platform specific Firebase Timestamp.

Link copied to clipboard
open class Query
Link copied to clipboard
actual class QuerySnapshot
expect class QuerySnapshot
actual class QuerySnapshot
actual class QuerySnapshot
actual class QuerySnapshot
Link copied to clipboard

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

Link copied to clipboard
actual class SnapshotMetadata
expect class SnapshotMetadata
actual class SnapshotMetadata
actual class SnapshotMetadata
actual class SnapshotMetadata
Link copied to clipboard
enum Source : Enum<Source>
Link copied to clipboard
@Serializable(with = TimestampSerializer::class)
actual class Timestamp : BaseTimestamp

A class representing a Firebase Timestamp.

@Serializable(with = TimestampSerializer::class)
expect class Timestamp : BaseTimestamp

A class representing a Firebase Timestamp.

@Serializable(with = TimestampSerializer::class)
actual class Timestamp : BaseTimestamp

A class representing a Firebase Timestamp.

@Serializable(with = TimestampSerializer::class)
actual class Timestamp : BaseTimestamp

A class representing a Firebase Timestamp.

@Serializable(with = TimestampSerializer::class)
actual class Timestamp : BaseTimestamp

A class representing a Firebase Timestamp.

Link copied to clipboard
object TimestampSerializer : KSerializer<Timestamp>

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

Link copied to clipboard
data class Transaction
Link copied to clipboard
sealed interface WhereConstraint
Link copied to clipboard
data class WriteBatch

Properties

Link copied to clipboard
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 LocalCacheSettings.android: LocalCacheSettings
val Query.android: Query
val QuerySnapshot.android: QuerySnapshot
val SnapshotMetadata.android: SnapshotMetadata
val Transaction.android: Transaction
val WriteBatch.android: WriteBatch
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 LocalCacheSettings.android: LocalCacheSettings
val Query.android: Query
val QuerySnapshot.android: QuerySnapshot
val SnapshotMetadata.android: SnapshotMetadata
val Transaction.android: Transaction
val WriteBatch.android: WriteBatch
Link copied to clipboard

Returns the FirebaseFirestore instance of the default FirebaseApp.

Link copied to clipboard
val ChangeType.ios: FIRDocumentChangeType
val CollectionReference.ios: FIRCollectionReference
val DocumentChange.ios: FIRDocumentChange
val DocumentReference.ios: FIRDocumentReference
val DocumentSnapshot.ios: FIRDocumentSnapshot
val FieldPath.ios: FIRFieldPath
val FirebaseFirestore.ios: FIRFirestore
val LocalCacheSettings.ios: FIRLocalCacheSettingsProtocol
val QuerySnapshot.ios: FIRQuerySnapshot
val SnapshotMetadata.ios: FIRSnapshotMetadata
val Transaction.ios: FIRTransaction
val WriteBatch.ios: FIRWriteBatch
Link copied to clipboard
val CollectionReference.js: CollectionReference
val DocumentChange.js: DocumentChange
val DocumentSnapshot.js: DocumentSnapshot
val FieldPath.js: FieldPath
val FirebaseFirestore.js: Firestore
val Query.js: Query
val QuerySnapshot.js: QuerySnapshot
val SnapshotMetadata.js: SnapshotMetadata
val Transaction.js: Transaction
val WriteBatch.js: WriteBatch

Functions

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