Firebase.Firestore.SnapshotMetadata

Metadata about a snapshot, describing the state of the snapshot.

Summary

Constructors and Destructors
SnapshotMetadata(bool hasPendingWrites, bool isFromCache)
Creates a new instance of the class.

Properties
HasPendingWrites
bool
true if the snapshot contains the result of local writes (e.g.
IsFromCache
bool
true if the snapshot was created from cached data rather than guaranteed up-to-date server data.

Public functions
Equals(object obj)
override bool
Equals(SnapshotMetadata other)
bool
Compares this snapshot metadata with another for equality.
GetHashCode()
override int

Properties

HasPendingWrites

bool HasPendingWrites

true if the snapshot contains the result of local writes (e.g.

SetAsync or UpdateAsync calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via MetadataChanges.Include) you will receive another snapshot with HasPendingWrites equal to false once the writes have been committed to the backend.

IsFromCache

bool IsFromCache

true if the snapshot was created from cached data rather than guaranteed up-to-date server data.

If your listener has opted into metadata updates (via MetadataChanges.Include) you will receive another snapshot with IsFromCache equal to false once the client has received up-to-date data from the backend.

Public functions

Equals

override bool Equals(
  object obj
)

Equals

bool Equals(
  SnapshotMetadata other
)

Compares this snapshot metadata with another for equality.

Details
Parameters
other
The snapshot metadata to compare this one with.
Returns
true if this snapshot metadata is equal to other ; false otherwise.

GetHashCode

override int GetHashCode()

SnapshotMetadata

 SnapshotMetadata(
  bool hasPendingWrites,
  bool isFromCache
)

Creates a new instance of the class.

Details
Parameters
hasPendingWrites
Indicates whether this snapshot has pending writes.
isFromCache
Indicates whether this snapshot is from the cache.