Classes
AggregateField
Represents a single aggregation within an AggregateQuery.
AggregateQuery
A query for running server-side aggregations. Instances of this can be created using Count() and Aggregate(AggregateField, params AggregateField[]).
AggregateQuerySnapshot
An immutable snapshot of aggregate query results.
CollectionReference
A reference to a collection in a Firestore database. The existence of this object does not imply that the collection currently exists in storage.
ConverterRegistry
Registry of custom converters. This is used to avoid requiring Firestore-specific attributes on types which may be intended to be non-Firestore-specific. The registry may be specified when creating a FirestoreDb via ConverterRegistry.
DocumentChange
A DocumentChange represents a change to the documents matching a query. It contains the document affected and a the type of change that occurred (added, modifed, or removed).
DocumentReference
A reference to a document in a Firestore database. The existence of this object does not imply that the document currently exists in storage.
DocumentSnapshot
An immutable snapshot of the data for a document.
FieldMask
An immutable set of field paths, used to limit the data returned by calls to GetAllSnapshotsAsync(IEnumerable<DocumentReference>, CancellationToken) and similar calls.
FieldPath
An immutable path of field names, used to identify parts of a document.
FieldValue
A static class providing properties and methods to represent sentinel values. Sentinel values are special values where the client-side value is not part of the document modification sent to the server. A property decorated with FirestorePropertyAttribute can specify an additional attribute to indicate that it's a sentinel value, such as aServerTimestampAttribute, or the sentinel values returned by the members of this class can be used directly as values to be serialized (for example, in anonymous types), and they will be handled directly by the serialization mechanism.
Filter
A holder for any type of filter.
FirestoreChangeListener
An ongoing "listen" or "watch" operation on either document or query snapshots.
This is returned from Listen methods.
FirestoreDataAttribute
Attribute indicating that a type is intended to be used with Firestore.
FirestoreDb
A Firestore database. Create instances using the static Create(string, FirestoreClient) and CreateAsync(string, FirestoreClient) methods, or using a FirestoreDbBuilder.
FirestoreDbBuilder
Builder class for FirestoreDb, providing simple configuration of credentials, endpoint, project ID etc.
FirestoreDeserializationConfigurationAttribute
Provides additional information for how Firestore converters (types implementing IFirestoreConverter<T>) should be called during deserialization.
FirestoreDocumentCreateTimestampAttribute
Attribute indicating that a property should be populated with the creation timestamp from a Firestore document snapshot.
FirestoreDocumentIdAttribute
Attribute indicating that a property should be populated with the Firestore document ID.
FirestoreDocumentReadTimestampAttribute
Attribute indicating that a property should be populated with the read timestamp from a Firestore document snapshot.
FirestoreDocumentUpdateTimestampAttribute
Attribute indicating that a property should be populated with the read timestamp from a Firestore document snapshot.
FirestoreEnumNameConverter<T>
Custom converter which uses enum value names instead of integer values as the Firestore representation. This converter is not used by default; it must be configured in the same way as any other custom converter.
FirestorePropertyAttribute
Attribute indicating that a property should be included in Firestore conversions.
Precondition
Immutable class representing a precondition for an update operation.
Query
A query against a collection.
QuerySnapshot
An immutable snapshot of complete query results.
ServerTimestampAttribute
Attribute indicating that the value of the property within the .NET object should be ignored when creating or modifying a document. Instead, the server time of the commit that creates or modifies the document is automatically used to populate the value in the Firestore document.
SetOptions
Immutable class representing options for Set operations.
Transaction
A transaction, as created by RunTransactionAsync<T>(Func<Transaction, Task<T>>, TransactionOptions, CancellationToken) (and overloads) and passed to user code.
TransactionOptions
Immutable class representing options for executing transactions.
WriteBatch
A batch of write operations, to be applied in a single commit.
WriteResult
The result of a write operation, in terms of the server's update time.
Structs
Blob
An immutable sequence of bytes.
GeoPoint
Immutable struct representing a geographic location in Firestore.
Timestamp
A nanosecond-precision immutable timestamp. When this is stored as part of a document in Firestore, it is truncated to the microsecond, towards the start of time.
Interfaces
IFirestoreConverter<T>
Custom converter used during serialization and deserialization.
Enums
DocumentChange.Type
An enumeration of snapshot change types.
UnknownPropertyHandling
Determines how unknown properties are handling when deserializing a Firestore document.