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.
Implements
IReadOnlyListDocumentSnapshot, IReadOnlyCollectionDocumentSnapshot, IEnumerableDocumentSnapshot, IEnumerable, IEquatableQuerySnapshotInherited Members
Namespace
Google.Cloud.FirestoreAssembly
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 |
|
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 | |
---|---|
Type | Description |
IEnumeratorDocumentSnapshot |
GetHashCode()
public override int GetHashCode()
Returns | |
---|---|
Type | Description |
int |