devsite/tools/jazzy/templates

FirebaseFirestore Framework Reference

DocumentChange

class DocumentChange : NSObject, @unchecked Sendable

A DocumentChange represents a change to the documents matching a query. It contains the document affected and the type of change that occurred (added, modified, or removed).

  • The type of change that occurred (added, modified, or removed).

    Declaration

    Swift

    var type: DocumentChangeType { get }

  • The document affected by this change.

    Declaration

    Swift

    var document: FIRQueryDocumentSnapshot { get }

  • 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). NSNotFound for DocumentChangeTypeAdded events.

    Declaration

    Swift

    var oldIndex: UInt { get }

  • 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). NSNotFound for DocumentChangeTypeRemoved events.

    Declaration

    Swift

    var newIndex: UInt { get }