cloud_firestore_platform_interface
library
Classes
-
Blob
-
Represents binary data stored in Uint8List.
-
CollectionReferencePlatform
-
A CollectionReferencePlatform can be used for adding documents, getting
document references, and querying for documents (using the methods
inherited from QueryPlatform).
Note: QueryPlatform extends PlatformInterface already.
-
DocumentChangePlatform
-
A change to the documents matching a query.
-
DocumentReferencePlatform
-
A DocumentReferencePlatform refers to a document location in a Firestore database
and can be used to write, read, or listen to the location.
-
DocumentSnapshotPlatform
-
Contains data read from a document in your Firestore
database.
-
FieldPath
-
A FieldPath refers to a field in a document.
-
FieldValueFactoryPlatform
-
An interface for a factory that is used to build a FieldValuePlatform according to
Platform (web or mobile)
-
FieldValuePlatform
-
A representation of a
FieldValue
that lives in the platform interface
and wraps an opaque value.
-
FirebaseFirestorePlatform
-
Defines an interface to work with Cloud Firestore on web and mobile
-
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.
-
PersistenceSettings
-
A settings class that can be passed to Firestore.enablePersistence() to configure Firestore persistence.
Only supported for Web.
-
QueryPlatform
-
Represents a query over the data at a particular location.
-
QuerySnapshotPlatform
-
A interface that contains zero or more DocumentSnapshotPlatform objects
representing the results of a query.
-
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.
-
SnapshotMetadataPlatform
-
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.
-
TransactionPlatform
-
A TransactionPlatform is a set of read and write operations on one or more documents.
-
WriteBatchPlatform
-
A write batch, used to perform multiple writes as a single atomic unit.
Functions
-
isValidCollectionPath(String collectionPath)
→ bool
-
Helper method exposed to determine whether a given
collectionPath
points to
a valid Firestore collection.
-
isValidDocumentPath(String documentPath)
→ bool
-
Helper method exposed to determine whether a given
documentPath
points to
a valid Firestore document.