firestore library
Classes
-
CollectionGroup<
T> -
CollectionReference<
T> -
DocumentChange<
T> - A DocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred.
-
DocumentReference<
T> -
DocumentSnapshot<
T> - A DocumentSnapshot is an immutable representation for a document in a Firestore database. The data can be extracted with data.
- FieldMask
- FieldPath
- FieldValue
- Filter
-
A
Filter
represents a restriction on one or more field values and can be used to refine the results of a Query.Filters
s are created by invoking Filter.where, Filter.or, or Filter.and and can then be passed to Query.where. to create a new Query instance that also contains thisFilter
. - FirebaseFirestoreAdminException
- Firestore
- GeoPoint
- An immutable object representing a geographic location in Firestore. The location is represented as a latitude/longitude pair.
-
Optional<
T> - Precondition
- A condition to check before performing an operation.
-
Query<
T> -
QueryDocumentSnapshot<
T> -
QuerySnapshot<
T> - A QuerySnapshot contains zero or more QueryDocumentSnapshot objects representing the results of a query.
- ReadOptions
- Settings
-
Settings used to directly configure a
Firestore
instance. - SettingsCredentials
- Timestamp
- WriteBatch
- A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.
- WriteResult
- A WriteResult wraps the write time set by the Firestore servers on sets(), updates(), and creates().
Typedefs
-
DocumentData
= Map<
String, Object?> - A type representing the raw Firestore document data.
-
FromFirestore<
T> = T Function(QueryDocumentSnapshot< DocumentData> value) -
ToFirestore<
T> = DocumentData Function(T value) -
UpdateMap
= Map<
FieldPath, Object?>