Firestore API - Class QuerySnapshot (3.5.1)

Version 3.5.1

• 3.7.0 (latest)
• 3.6.0
• 3.5.1
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.5.0
• 2.4.0
• 2.3.1

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

Reference documentation and code samples for the Firestore API class QuerySnapshot.

An immutable snapshot of complete query results.

Inheritance

object > QuerySnapshot

Implements

IReadOnlyListDocumentSnapshot, IReadOnlyCollectionDocumentSnapshot, IEnumerableDocumentSnapshot, IEnumerable, IEquatableQuerySnapshot

Inherited Members

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Properties

Changes

public IReadOnlyList<DocumentChange> Changes { get; }

The changes in the documents.

Property Value
Type	Description
IReadOnlyListDocumentChange

Count

public int Count { get; }

Returns the number of documents in this query snapshot.

Property Value
Type	Description
int	The number of documents in this query snapshot.

Documents

public IReadOnlyList<DocumentSnapshot> Documents { get; }

The documents in the snapshot.

Property Value
Type	Description
IReadOnlyListDocumentSnapshot

this[int]

public DocumentSnapshot this[int index] { get; }

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

Parameter
Name	Description
index	int The index of the document to return.

Property Value
Type	Description
DocumentSnapshot	The document snapshot with the specified index within this query snapshot.

Exceptions
Type	Description
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
Type	Description
Query

ReadTime

public Timestamp ReadTime { get; }

The time at which the snapshot was read.

Property Value
Type	Description
Timestamp

Methods

GetEnumerator()

public IEnumerator<DocumentSnapshot> GetEnumerator()

Returns an enumerator that iterates through the collection.

Returns
Type	Description
IEnumeratorDocumentSnapshot	An enumerator that can be used to iterate through the collection.

GetHashCode()

public override int GetHashCode()

Serves as the default hash function.

Returns
Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()