Firebase.Firestore
Summary
Enumerations |
|
---|---|
AggregateSource{
|
enum The sources from which an AggregateQuery.GetSnapshotAsync can retrieve its results. |
FirestoreError{
|
enum Error codes used by Cloud Firestore. |
MetadataChanges{
|
enum Indicates whether metadata-only changes (that is, DocumentSnapshot.Metadata or QuerySnapshot.Metadata changed) should trigger snapshot events. |
ServerTimestampBehavior{
|
enum Controls the return value for server timestamps that have not yet been set to their final value. |
Source{
|
enum Configures the behavior of DocumentReference.GetSnapshotAsync and Query.GetSnapshotAsync. |
UnknownPropertyHandling{
|
enum Determines how unknown properties are handled when deserializing a Firestore document. |
Typedefs |
|
---|---|
DocumentSnapshotCallbackMap
|
usingListenerRegistrationMap< Action< DocumentSnapshotProxy, FirestoreError, string >>
|
LoadBundleProgressCallbackMap
|
usingListenerRegistrationMap< Action< LoadBundleTaskProgress >>
|
QuerySnapshotCallbackMap
|
usingListenerRegistrationMap< Action< QuerySnapshotProxy, FirestoreError, string >>
|
SnapshotsInSyncCallbackMap
|
usingListenerRegistrationMap< Action >
|
Classes |
|
---|---|
Firebase. |
A query that calculates aggregations over an underlying query. |
Firebase. |
The results of executing an |
Firebase. |
A reference to a collection in a Firestore database. |
Firebase. |
A DocumentChange represents a change to the documents matching a query. |
Firebase. |
A |
Firebase. |
An immutable snapshot of the data for a document. |
Firebase. |
An immutable path of field names, used to identify parts of a document. |
Firebase. |
A static class providing properties and methods to represent sentinel values. |
Firebase. |
A Filter represents a restriction on one or more field values and can be used to refine the results of a Query. |
Firebase. |
Represents a Cloud Firestore database and is the entry point for all Cloud Firestore operations. |
Firebase. |
Settings used to configure a FirebaseFirestore instance. |
Firebase. |
Attribute indicating that a type is intended to be used with Firestore. |
Firebase. |
Attribute indicating that a property should be populated with the Firestore document ID. |
Firebase. |
Custom converter which uses enum value names instead of integer values as the Firestore representation. |
Firebase. |
A class of exceptions thrown by Cloud Firestore. |
Firebase. |
Attribute indicating that a property should be included in Firestore conversions. |
Firebase. |
Represents a listener for either document or query snapshots that is returned from |
Firebase. |
|
Firebase. |
A query which you can read or listen to. |
Firebase. |
A |
Firebase. |
Attribute indicating that a timestamp property should be populated with a server timestamp. |
Firebase. |
An options object that configures the behavior of |
Firebase. |
Metadata about a snapshot, describing the state of the snapshot. |
Firebase. |
A transaction, as created by FirebaseFirestore.RunTransactionAsync{T}(System.Func{Transaction, Task{T}}) (and overloads) and passed to user code. |
Firebase. |
Options to customize transaction behavior for FirebaseFirestore.RunTransactionAsync. |
Firebase. |
A batch of write operations, used to perform multiple writes as a single atomic unit. |
Structs |
|
---|---|
Firebase. |
An immutable sequence of bytes. |
Firebase. |
Immutable struct representing a geographic location in Cloud Firestore. |
Firebase. |
A nanosecond-precision immutable timestamp. |
Enumerations
AggregateSource
AggregateSource
The sources from which an AggregateQuery.GetSnapshotAsync can retrieve its results.
Properties | |
---|---|
Server
|
Perform the aggregation on the server and download the result. The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every request using this source necessarily involves a round trip to the server. The AggregateQuery will fail if the server cannot be reached, such as if the client is offline. |
FirestoreError
FirestoreError
Error codes used by Cloud Firestore.
The codes are in sync across Firestore SDKs on various platforms.
Properties | |
---|---|
Aborted
|
The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. |
AlreadyExists
|
Some document that we attempted to create already exists. |
Cancelled
|
The operation was cancelled (typically by the caller). |
DataLoss
|
Unrecoverable data loss or corruption. |
DeadlineExceeded
|
Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. |
FailedPrecondition
|
Operation was rejected because the system is not in a state required for the operation's execution. |
Internal
|
Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. |
InvalidArgument
|
Client specified an invalid argument. Note that this differs from |
NotFound
|
Some requested document was not found. |
Ok
|
The operation completed successfully. |
OutOfRange
|
Operation was attempted past the valid range. |
PermissionDenied
|
The caller does not have permission to execute the specified operation. |
ResourceExhausted
|
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. |
Unauthenticated
|
The request does not have valid authentication credentials for the operation. |
Unavailable
|
The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. |
Unimplemented
|
Operation is not implemented or not supported/enabled. |
Unknown
|
Unknown error or an error from a different error domain. |
MetadataChanges
MetadataChanges
Indicates whether metadata-only changes (that is, DocumentSnapshot.Metadata or QuerySnapshot.Metadata changed) should trigger snapshot events.
ServerTimestampBehavior
ServerTimestampBehavior
Controls the return value for server timestamps that have not yet been set to their final value.
Properties | |
---|---|
Estimate
|
Return local estimates for server timestamps that have not yet been set to their final value. This estimate will likely differ from the final value and may cause these pending values to change once the server result becomes available. |
None
|
Return |
Previous
|
Return the previous value for server timestamps that have not yet been set to their final value. |
Source
Source
Configures the behavior of DocumentReference.GetSnapshotAsync and Query.GetSnapshotAsync.
By providing a Source
value, these methods can be configured to fetch results only from the server, only from the local cache, or attempt to fetch results from the server and fall back to the cache (which is the default).
Properties | |
---|---|
Cache
|
Causes Firestore to immediately return a value from the cache, ignoring the server completely (implying that the returned value may be stale with respect to the value on the server). If there is no data in the cache to satisfy the DocumentReference.GetSnapshotAsync call will return an error and Query.GetSnapshotAsync will return an empty |
Default
|
Causes Firestore to try to retrieve an up-to-date (server-retrieved) snapshot, but fall back to returning cached data if the server can't be reached. |
Server
|
Causes Firestore to avoid the cache, generating an error if the server cannot be reached. Note that the cache will still be updated if the server request succeeds. Also note that latency-compensation still takes effect, so any pending write operations will be visible in the returned data (merged into the server-provided data). |
UnknownPropertyHandling
UnknownPropertyHandling
Typedefs
DocumentSnapshotCallbackMap
ListenerRegistrationMap< Action< DocumentSnapshotProxy, FirestoreError, string >> DocumentSnapshotCallbackMap
LoadBundleProgressCallbackMap
ListenerRegistrationMap< Action< LoadBundleTaskProgress >> LoadBundleProgressCallbackMap
QuerySnapshotCallbackMap
ListenerRegistrationMap< Action< QuerySnapshotProxy, FirestoreError, string >> QuerySnapshotCallbackMap
SnapshotsInSyncCallbackMap
ListenerRegistrationMap< Action > SnapshotsInSyncCallbackMap