devsite/tools/jazzy/templates

FirebaseFirestore Framework Reference

QuerySnapshot

class QuerySnapshot : NSObject, @unchecked Sendable

A QuerySnapshot contains zero or more DocumentSnapshot objects. It can be enumerated using the documents property and its size can be inspected with isEmpty and count.

  • The query on which you called getDocuments or listened to in order to get this QuerySnapshot.

    Declaration

    Swift

    var query: FIRQuery { get }

  • Metadata about this snapshot, concerning its source and if it has local modifications.

    Declaration

    Swift

    var metadata: FIRSnapshotMetadata { get }

  • Indicates whether this QuerySnapshot is empty (contains no documents).

    Declaration

    Swift

    var isEmpty: Bool { get }

  • The count of documents in this QuerySnapshot.

    Declaration

    Swift

    var count: Int { get }

  • An Array of the DocumentSnapshots that make up this document set.

    Declaration

    Swift

    var documents: [FIRQueryDocumentSnapshot] { get }

  • An array of the documents that changed since the last snapshot. If this is the first snapshot, all documents will be in the list as Added changes.

    Declaration

    Swift

    var documentChanges: [FIRDocumentChange] { get }

  • Returns an array of the documents that changed since the last snapshot. If this is the first snapshot, all documents will be in the list as Added changes.

    Declaration

    Swift

    func documentChanges(includeMetadataChanges: Bool) -> [FIRDocumentChange]

    Parameters

    includeMetadataChanges

    Whether metadata-only changes (i.e. only DocumentSnapshot.metadata changed) should be included.