Firebase.Firestore.DocumentChange

A DocumentChange represents a change to the documents matching a query.

Summary

It contains the document affected and the type of change that occurred (added, modified, or removed).

Public types

Type{
  Added = 0,
  Modified = 1,
  Removed = 2
}
enum
An enumeration of DocumentChange types.

Properties

ChangeType
Returns the type of the DocumentChange.
NewIndex
int
The index of the changed document in the result set immediately after this DocumentChange (i.e.
OldIndex
int
The index of the changed document in the result set immediately prior to this DocumentChange (i.e.

Public attributes

Document => new DocumentSnapshot(_proxy.document(), _firestore)
Returns the newly added or modified document if this DocumentChange is for an updated document.

Public functions

Equals(object obj)
override bool
Equals(DocumentChange other)
bool
GetHashCode()
override int

Public types

Type

 Type

An enumeration of DocumentChange types.

Properties
Added

Indicates a new document was added to the set of documents matching the query.

Modified

Indicates document within the query was modified.

Removed

Indicates a document within the query was removed (either deleted or no longer matches the query).

Properties

ChangeType

Type ChangeType

Returns the type of the DocumentChange.

NewIndex

int NewIndex

The index of the changed document in the result set immediately after this DocumentChange (i.e.

supposing that all prior DocumentChange objects and the current DocumentChange object have been applied). Returns -1 for 'removed' events.

OldIndex

int OldIndex

The index of the changed document in the result set immediately prior to this DocumentChange (i.e.

supposing that all prior DocumentChange objects have been applied). Returns -1 for 'added' events.

Public attributes

Document

DocumentSnapshot Document => new DocumentSnapshot(_proxy.document(), _firestore)

Returns the newly added or modified document if this DocumentChange is for an updated document.

Returns the deleted document if this document change represents a removal.

Public functions

Equals

override bool Equals(
  object obj
)

Equals

bool Equals(
  DocumentChange other
)

GetHashCode

override int GetHashCode()