Namespace Google.Cloud.Firestore (2.4.0)

A reference to a collection in a Firestore database. The existence of this object does not imply that the collection currently exists in storage.

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.

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).

A reference to a document in a Firestore database. The existence of this object does not imply that the document currently exists in storage.

An immutable snapshot of the data for a document.

An immutable set of field paths, used to limit the data returned by calls to GetAllSnapshotsAsync(IEnumerable<DocumentReference>, CancellationToken) and similar calls.

An immutable path of field names, used to identify parts of a document.

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.

An ongoing "listen" or "watch" operation on either document or query snapshots. This is returned from Listen methods.

Attribute indicating that a type is intended to be used with Firestore.

A Firestore database. Create instances using the static Create(String, FirestoreClient) and CreateAsync(String, FirestoreClient) methods, or using a FirestoreDbBuilder.

Builder class for FirestoreDb, providing simple configuration of credentials, endpoint, project ID etc.

Provides additional information for how Firestore converters (types implementing IFirestoreConverter<T>) should be called during deserialization.

Attribute indicating that a property should be populated with the creation timestamp from a Firestore document snapshot.

Attribute indicating that a property should be populated with the Firestore document ID.

Attribute indicating that a property should be populated with the read timestamp from a Firestore document snapshot.

Attribute indicating that a property should be populated with the read timestamp from a Firestore document snapshot.

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.

Attribute indicating that a property should be included in Firestore conversions.

Immutable class representing a precondition for an update operation.

A query against a collection.

An immutable snapshot of complete query results.

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.

Immutable class representing options for Set operations.

A transaction, as created by RunTransactionAsync<T>(Func<Transaction, Task<T>>, TransactionOptions, CancellationToken) (and overloads) and passed to user code.

Immutable class representing options for executing transactions.

A batch of write operations, to be applied in a single commit.

The result of a write operation, in terms of the server's update time.

An immutable sequence of bytes.

Immutable struct representing a geographic location in Firestore.

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.

Custom converter used during serialization and deserialization.

An enumeration of snapshot change types.

Determines how unknown properties are handling when deserializing a Firestore document.