flamingo library

Classes

AggregateField
AggregateQuery
AggregateQuery represents the data at a particular location for retrieving metadata without retrieving the actual documents.
AggregateQuerySnapshot
AggregateQuerySnapshot represents a response to an AggregateQuery request.
average
Create an object that can be used to compute the average of a specified field over a range of documents in the result set of a query.
Batch
BatchRepository
Blob
Represents binary data stored in Uint8List.
Collection<T extends Document<DocumentType>>
CollectionPaging<T extends Document<T>>
CollectionPagingListener<T extends Document<T>>
CollectionPagingListener is SnapshotListener + Paging features.
CollectionReference<T extends Object?>
count
Create a CountAggregateField object that can be used to compute the count of documents in the result set of a query.
Counter
DistributedCounter
DistributedCounterRepository
Document<T>
DocumentAccessor
DocumentAccessorRepository
DocumentChange<T extends Object?>
A DocumentChange represents a change to the documents matching a query.
DocumentChangeData<T extends Document<T>>
DocumentReference<T extends Object?>
A DocumentReference refers to a document location in a FirebaseFirestore database and can be used to write, read, or listen to the location.
DocumentSnapshot<T extends Object?>
A DocumentSnapshot contains data read from a document in your FirebaseFirestore database.
DocumentType
DownloadTask
A class which indicates an on-going download task.
FieldOverrideIndex
FieldOverrides
The FieldOverrides class follows the FieldOverrides definition.
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().
Filter
A Filter represents a restriction on one or more field values and can be used to refine the results of a Query.
FirebaseFirestore
The entry point for accessing a FirebaseFirestore.
FirebaseStorage
The entrypoint for FirebaseStorage.
Flamingo
Flamingo
FullMetadata
The result of calling getMetadata on a storage object reference.
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.
Helper
Increment<T extends num>
Index
The Index class follows the Index definition.
IndexField
ListEquality<E>
Equality on lists.
ListOptions
The options FirebaseStoragePlatform.list accepts.
ListResult
Class returned as a result of calling a list method (list or listAll) on a Reference.
LoadBundleTask
LoadBundleTaskSnapshot
A LoadBundleTaskSnapshot is returned as the result or on-going process of a LoadBundleTask.
Model
PersistenceSettings
A settings class that can be passed to Firestore.enablePersistence() to configure Firestore persistence. Only supported for Web.
Query<T extends Object?>
Represents a Query over the data at a particular location.
QueryDocumentSnapshot<T extends Object?>
A QueryDocumentSnapshot contains data read from a document in your FirebaseFirestore database as part of a query.
QuerySnapshot<T extends Object?>
Contains the results of a query. It can contain zero or more DocumentSnapshot objects.
Reference
Represents a reference to a Google Cloud Storage object. Developers can upload, download, and delete objects, as well as get/set object metadata.
RunTransaction
SetOptions
An options class that configures the behavior of set() calls in DocumentReference, WriteBatch and Transaction.
SettableMetadata
The settable metadata a storage object reference can be set with.
Settings
Specifies custom configurations for your Cloud Firestore instance.
SnapshotMetadata
Metadata about a snapshot, describing the state of the snapshot.
SnapshotOptions
Options that configure how data is retrieved from a DocumentSnapshot (e.g. the desired behavior for server timestamps that have not yet been set to their final value).
Storage
StorageFile
StorageRepository
sum
Create an object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.
Task
A class representing an on-going storage task that additionally delegates to a Future.
TaskSnapshot
A TaskSnapshot is returned as the result or on-going process of a Task.
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().
UploadTask
A class which indicates an on-going upload task.
WriteBatch
A WriteBatch is a series of write operations to be performed as one unit.

Enums

AggregateSource
AggregateSource represents the source of data for an AggregateQuery.
ArrayConfig
DocumentChangeType
An enumeration of document change types.
ExecuteType
ListenSource
The listener retrieves data and listens to updates from the local Firestore cache only. If the cache is empty, an empty snapshot will be returned. Snapshot events will be triggered on cache updates, like local mutations or load bundles.
LoadBundleTaskState
Represents the state of an on-going LoadBundleTask.
Order
PutStringFormat
The format in which a string can be uploaded to the storage bucket via Reference.putString.
QueryScope
ServerTimestampBehavior
Source
An enumeration of firestore source types.
TaskState
Represents the state of an on-going Task.

Properties

firestoreInstance → FirebaseFirestore
Firestore Instance
no setter
rootReference → DocumentReference<Map<String, dynamic>>
RootReference
no setter
storageInstance → FirebaseStorage
FirebaseStorage Instance
no setter

Functions

collectionReference(String path) → CollectionReference<Object?>
CollectionReference

Typedefs

FromFirestore<T> = T Function(DocumentSnapshot<Map<String, dynamic>> snapshot, SnapshotOptions? options)
ToFirestore<T> = Map<String, Object?> Function(T value, SetOptions? options)
TransactionHandler<T> = Future<T> Function(Transaction transaction)
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.