Firebase. Firestore
Summary
Enumerations | |
|---|---|
AggregateSource{ | enum The sources from which anAggregateQuery.GetSnapshotAsync can retrieve its results. |
FirestoreError{ | enum Error codes used by CloudFirestore. |
MetadataChanges{ | enum Indicates whether metadata-only changes (that is,DocumentSnapshot.Metadata orQuerySnapshot.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 ofDocumentReference.GetSnapshotAsync andQuery.GetSnapshotAsync. |
UnknownPropertyHandling{ | enum Determines how unknown properties are handled when deserializing aFirestore 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 aFirestore database. |
| Firebase. | ADocumentChange 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. | AFilter represents a restriction on one or more field values and can be used to refine the results of aQuery. |
| Firebase. | Represents a CloudFirestore database and is the entry point for all CloudFirestore operations. |
| Firebase. | Settings used to configure aFirebaseFirestore instance. |
| Firebase. | Attribute indicating that a type is intended to be used withFirestore. |
| Firebase. | Attribute indicating that a property should be populated with theFirestore document ID. |
| Firebase. | Custom converter which uses enum value names instead of integer values as theFirestore representation. |
| Firebase. | A class of exceptions thrown by CloudFirestore. |
| Firebase. | Attribute indicating that a property should be included inFirestore 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 forFirebaseFirestore.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 CloudFirestore. |
| Firebase. | A nanosecond-precision immutable timestamp. |
Enumerations
AggregateSource
AggregateSourceThe sources from which anAggregateQuery.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. TheAggregateQuery will fail if the server cannot be reached, such as if the client is offline. |
FirestoreError
FirestoreErrorError codes used by CloudFirestore.
The codes are in sync acrossFirestore SDKs on various platforms.
MetadataChanges
MetadataChangesIndicates whether metadata-only changes (that is,DocumentSnapshot.Metadata orQuerySnapshot.Metadata changed) should trigger snapshot events.
| Properties | |
|---|---|
Exclude | Snapshot events will not be triggered by metadata-only changes. |
Include | Snapshot events will be triggered by any changes, including metadata-only changes. |
ServerTimestampBehavior
ServerTimestampBehaviorControls the return value for server timestamps that have not yet been set to their final value.
Source
SourceConfigures the behavior ofDocumentReference.GetSnapshotAsync andQuery.GetSnapshotAsync.
By providing aSource 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 | CausesFirestore 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 theDocumentReference.GetSnapshotAsync call will return an error andQuery.GetSnapshotAsync will return an empty |
Default | CausesFirestore 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 | CausesFirestore 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
UnknownPropertyHandlingDetermines how unknown properties are handled when deserializing aFirestore document.
| Properties | |
|---|---|
Ignore | Unknown properties are silently ignored. |
Throw | Unknown properties cause an exception to be thrown. |
Warn | Unknown properties cause a warning, but no error. |
Typedefs
DocumentSnapshotCallbackMap
ListenerRegistrationMap<Action<DocumentSnapshotProxy,FirestoreError,string>>DocumentSnapshotCallbackMap
LoadBundleProgressCallbackMap
ListenerRegistrationMap<Action<LoadBundleTaskProgress>>LoadBundleProgressCallbackMap
QuerySnapshotCallbackMap
ListenerRegistrationMap<Action<QuerySnapshotProxy,FirestoreError,string>>QuerySnapshotCallbackMap
SnapshotsInSyncCallbackMap
ListenerRegistrationMap<Action>SnapshotsInSyncCallbackMap
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-13 UTC.