Firebase.Firestore.QuerySnapshot

A QuerySnapshot contains the results of a query.

Summary

It can contain zero or more DocumentSnapshot objects.

Inheritance

Inherits from: global::SystemCollections::Generic::IEnumerable< DocumentSnapshot >

Public attributes

Query => new Query(_proxy.query(), _firestore)
The query producing this snapshot.

Properties

Count
int
Returns the number of documents in this query snapshot.
Documents
IEnumerable< DocumentSnapshot >
The documents in the snapshot.
Metadata
The metadata for this QuerySnapshot.
this[int index]
Returns the document snapshot with the specified index within this query snapshot.

Public functions

Equals(object obj)
override bool
Equals(QuerySnapshot other)
bool
GetChanges()
IEnumerable< DocumentChange >
The list of documents that changed since the last snapshot.
GetChanges(MetadataChanges metadataChanges)
IEnumerable< DocumentChange >
The list of documents that changed since the last snapshot.
GetHashCode()
override int

Public attributes

Query

Query Query => new Query(_proxy.query(), _firestore)

The query producing this snapshot.

Properties

Count

int Count

Returns the number of documents in this query snapshot.

The number of documents in this query snapshot.

Documents

IEnumerable< DocumentSnapshot > Documents

The documents in the snapshot.

Metadata

SnapshotMetadata Metadata

The metadata for this QuerySnapshot.

this[int index]

DocumentSnapshot this[int index]

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

Details
Parameters
index
The index of the document to return.
Exceptions
ArgumentOutOfRangeException
index is less than 0, or greater than or equal to Count.
Returns
The document snapshot with the specified index within this query snapshot.

Public functions

Equals

override bool Equals(
  object obj
)

Equals

bool Equals(
  QuerySnapshot other
)

GetChanges

IEnumerable< DocumentChange > GetChanges()

The list of documents that changed since the last snapshot.

If it's the first snapshot all documents will be in the list as added changes.

Documents with changes only to their metadata will not be included.

Details
Returns
The list of document changes since the last snapshot.

GetChanges

IEnumerable< DocumentChange > GetChanges(
  MetadataChanges metadataChanges
)

The list of documents that changed since the last snapshot.

If it's the first snapshot all documents will be in the list as added changes.

Details
Parameters
metadataChanges
Indicates whether metadata-only changes (i.e. only Firebase.Firestore.DocumentSnapshot.Metadata changed) should be included.
Returns
The list of document changes since the last snapshot.

GetHashCode

override int GetHashCode()