Class QuerySnapshot (3.0.0)

public sealed class QuerySnapshot : IReadOnlyList<DocumentSnapshot>, IReadOnlyCollection<DocumentSnapshot>, IEnumerable<DocumentSnapshot>, IEnumerable, IEquatable<QuerySnapshot>

An immutable snapshot of complete query results.

Inheritance

Object > QuerySnapshot

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Properties

Changes

public IReadOnlyList<DocumentChange> Changes { get; }

The changes in the documents.

Property Value
TypeDescription
IReadOnlyList<DocumentChange>

Count

public int Count { get; }

Returns the number of documents in this query snapshot.

Property Value
TypeDescription
Int32

The number of documents in this query snapshot.

Documents

public IReadOnlyList<DocumentSnapshot> Documents { get; }

The documents in the snapshot.

Property Value
TypeDescription
IReadOnlyList<DocumentSnapshot>

Item[Int32]

public DocumentSnapshot this[int index] { get; }

Returns the document snapshot with the specified index within this query snapshot.

Parameter
NameDescription
indexInt32

The index of the document to return.

Property Value
TypeDescription
DocumentSnapshot

The document snapshot with the specified index within this query snapshot.

Exceptions
TypeDescription
ArgumentOutOfRangeException

index is less than 0, or greater than or equal to Count.

Query

public Query Query { get; }

The query producing this snapshot.

Property Value
TypeDescription
Query

ReadTime

public Timestamp ReadTime { get; }

The time at which the snapshot was read.

Property Value
TypeDescription
Timestamp

Methods

GetEnumerator()

public IEnumerator<DocumentSnapshot> GetEnumerator()
Returns
TypeDescription
IEnumerator<DocumentSnapshot>

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32
Overrides

Explicit Interface Implementations

IEnumerable.GetEnumerator()

IEnumerator IEnumerable.GetEnumerator()
Returns
TypeDescription
IEnumerator