firebase-firestore/dev.gitlive.firebase.firestore

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)
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
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
actual enum ChangeType : Enum<ChangeType>
expect enum ChangeType : Enum<ChangeType>
actual enum ChangeType : Enum<ChangeType>
actual typealias ChangeType = DocumentChange.Type
Link copied to clipboard
data class CollectionReference : Query
Link copied to clipboard
actual typealias Direction = Query.Direction
actual enum Direction : Enum<Direction>
expect enum Direction : Enum<Direction>
actual enum Direction : Enum<Direction>
actual typealias Direction = Query.Direction
Link copied to clipboard
actual class DocumentChange
actual class DocumentChange
expect class DocumentChange
actual class DocumentChange
actual class DocumentChange
Link copied to clipboard
@Serializable(with = DocumentReferenceSerializer::class)
data class DocumentReference

A class representing a Firebase DocumentReference.

Link copied to clipboard
object DocumentReferenceSerializer : KSerializer<DocumentReference>

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
actual typealias EncodedFieldPath = <Error class: unknown class>
expect class EncodedFieldPath
actual typealias EncodedFieldPath = FieldPath
actual typealias EncodedFieldPath = FieldPath
Link copied to clipboard
actual class FieldPath(fieldNames: String)
actual class FieldPath(fieldNames: String)
expect class FieldPath(fieldNames: String)
actual class FieldPath(fieldNames: String)
actual class FieldPath(fieldNames: String)
Link copied to clipboard
class FieldsAndValuesUpdateDSL : EncodeSettings.Builder

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.

Link copied to clipboard
@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)
expect class FieldValue

Represents a Firebase FieldValue.

@Serializable
actual class FieldValue

Represents a Firebase FieldValue.

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

Represents a Firebase FieldValue.

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

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 class FirebaseFirestoreException : FirebaseException
expect class FirebaseFirestoreException : FirebaseException
actual class FirebaseFirestoreException : FirebaseException
actual typealias FirebaseFirestoreException = com.google.firebase.firestore.FirebaseFirestoreException
Link copied to clipboard
actual data class FirebaseFirestoreSettings
actual data class FirebaseFirestoreSettings
expect class FirebaseFirestoreSettings
actual data class FirebaseFirestoreSettings
actual data class FirebaseFirestoreSettings
Link copied to clipboard
actual typealias FirestoreExceptionCode = FirebaseFirestoreException.Code
actual enum FirestoreExceptionCode : Enum<FirestoreExceptionCode>
expect enum FirestoreExceptionCode : Enum<FirestoreExceptionCode>
actual enum FirestoreExceptionCode : Enum<FirestoreExceptionCode>
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)
actual class GeoPoint

A class representing a Firebase GeoPoint.

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

A class representing a Firebase GeoPoint.

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

actual typealias NativeGeoPoint = <Error class: unknown class>

A class representing a platform specific Firebase GeoPoint.

expect class NativeGeoPoint

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.

actual typealias NativeTimestamp = <Error class: unknown class>

A class representing a platform specific Firebase Timestamp.

expect class NativeTimestamp

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
Link copied to clipboard
open class Query
Link copied to clipboard
actual class QuerySnapshot
actual class QuerySnapshot
expect class QuerySnapshot
actual class QuerySnapshot
actual class QuerySnapshot
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
actual class SnapshotMetadata
actual class SnapshotMetadata
expect 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)
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
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
Link copied to clipboard
actual val Firebase.firestore: FirebaseFirestore
actual val Firebase.firestore: FirebaseFirestore
expect val Firebase.firestore: FirebaseFirestore

Returns the FirebaseFirestore instance of the default FirebaseApp.

actual val Firebase.firestore: FirebaseFirestore
actual val Firebase.firestore: FirebaseFirestore
Link copied to clipboard
val ChangeType.ios: <Error class: unknown class>
val CollectionReference.ios: <Error class: unknown class>
val DocumentChange.ios: <Error class: unknown class>
val DocumentReference.ios: <Error class: unknown class>
val DocumentSnapshot.ios: <Error class: unknown class>
val FieldPath.ios: <Error class: unknown class>
val FirebaseFirestore.ios: <Error class: unknown class>
val LocalCacheSettings.ios: <Error class: unknown class>
val Query.ios: <Error class: unknown class>
val QuerySnapshot.ios: <Error class: unknown class>
val SnapshotMetadata.ios: <Error class: unknown class>
val Transaction.ios: <Error class: unknown class>
val WriteBatch.ios: <Error class: unknown class>
Link copied to clipboard
val <Error class: unknown class>.js: CollectionReference
val <Error class: unknown class>.js: NativeDocumentReferenceType
val <Error class: unknown class>.js: DocumentSnapshot
val <Error class: unknown class>.js: Firestore
val <Error class: unknown class>.js: Query
val <Error class: unknown class>.js: Transaction
val <Error class: unknown class>.js: WriteBatch
val DocumentChange.js: DocumentChange
val FieldPath.js: FieldPath
val QuerySnapshot.js: QuerySnapshot
val SnapshotMetadata.js: SnapshotMetadata

Functions

Link copied to clipboard
actual fun Firebase.firestore(app: FirebaseApp, databaseId: String?): FirebaseFirestore
actual fun Firebase.firestore(app: FirebaseApp, databaseId: String?): FirebaseFirestore
expect fun Firebase.firestore(app: FirebaseApp, databaseId: String? = null): FirebaseFirestore

Returns the FirebaseFirestore instance of a given FirebaseApp.

actual fun Firebase.firestore(app: FirebaseApp, databaseId: String?): FirebaseFirestore
actual fun Firebase.firestore(app: FirebaseApp, databaseId: String?): FirebaseFirestore
Link copied to clipboard
Link copied to clipboard
fun Timestamp.Companion.fromDuration(duration: <Error class: unknown class>): Timestamp
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: <Error class: unknown class>): CollectionReference
operator fun DocumentReference.Companion.invoke(ios: <Error class: unknown class>): DocumentReference
operator fun DocumentSnapshot.Companion.invoke(ios: <Error class: unknown class>): DocumentSnapshot
operator fun FirebaseFirestore.Companion.invoke(ios: <Error class: unknown class>): FirebaseFirestore
operator fun Query.Companion.invoke(ios: <Error class: unknown class>): Query
operator fun Transaction.Companion.invoke(ios: <Error class: unknown class>): Transaction
operator fun WriteBatch.Companion.invoke(ios: <Error class: unknown class>): WriteBatch
operator fun <Error class: unknown class>.invoke(js: CollectionReference): <Error class: unknown class>
operator fun <Error class: unknown class>.invoke(js: DocumentReference): <Error class: unknown class>
operator fun <Error class: unknown class>.invoke(js: DocumentSnapshot): <Error class: unknown class>
operator fun <Error class: unknown class>.invoke(js: Firestore): <Error class: unknown class>
operator fun <Error class: unknown class>.invoke(js: Query): <Error class: unknown class>
operator fun <Error class: unknown class>.invoke(js: Transaction): <Error class: unknown class>
operator fun <Error class: unknown class>.invoke(js: WriteBatch): <Error class: unknown class>
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
Link copied to clipboard
fun Timestamp.toDuration(): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.toException(): FirebaseFirestoreException
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