discontinuedPackage dart_firebase_admin_plus has been discontinued.

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. Filterss 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 this Filter.

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

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 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().

Enums

DocumentChangeType

FirestoreClientErrorCode

Firestore client error codes and their default messages.

LimitType

WhereFilter

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)

TransactionHandler<T> = Future<T> Function(Transaction transaction)

The TransactionHandler may be executed multiple times; it should be able to handle multiple executions.

UpdateMap = Map<FieldPath, Object?>

Exceptions / Errors

FirebaseFirestoreAdminException