cloud_firestore library

Classes

Blob
Represents binary data stored in Uint8List.
CollectionReference
A CollectionReference object can be used for adding documents, getting DocumentReferences, and querying for documents (using the methods inherited from Query).
DocumentChange
A DocumentChange represents a change to the documents matching a query. [...]
DocumentReference
A DocumentReference refers to a document location in a FirebaseFirestore database and can be used to write, read, or listen to the location. [...]
DocumentSnapshot
A DocumentSnapshot contains data read from a document in your FirebaseFirestore database. [...]
FieldPath
A FieldPath refers to a field in a document. [...]
FieldValue
Sentinel values that can be used when writing document fields with set() or update(). [...]
FirebaseFirestore
The entry point for accessing a FirebaseFirestore. [...]
GeoPoint
Represents a geographical point by its longitude and latitude
GetOptions
An options class that configures the behavior of get() calls on DocumentReference and Query. [...]
ListEquality<E>
Equality on lists. [...]
Query
Represents a Query over the data at a particular location. [...]
QueryDocumentSnapshot
A QueryDocumentSnapshot contains data read from a document in your FirebaseFirestore database as part of a query. [...]
QuerySnapshot
Contains the results of a query. It can contain zero or more DocumentSnapshot objects.
SetOptions
An options class that configures the behavior of set() calls in DocumentReference, WriteBatch and Transaction.
Settings
Specifies custom configurations for your Cloud Firestore instance. [...]
SnapshotMetadata
Metadata about a snapshot, describing the state of the snapshot.
Timestamp
A Timestamp represents a point in time independent of any time zone or calendar, represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings. [...]
Transaction
Transaction class which is created from a call to runTransaction().
WriteBatch
A WriteBatch is a series of write operations to be performed as one unit. [...]

Enums

DocumentChangeType
An enumeration of document change types.
Source
An enumeration of firestore source types.

Typedefs

TransactionHandler<T>(Transaction transaction) Future<T>
The TransactionHandler may be executed multiple times; it should be able to handle multiple executions.

Exceptions / Errors

FirebaseException
A generic class which provides exceptions in a Firebase-friendly format to users. [...]