Blog Go to console

FirebaseFirestore Framework Reference

QuerySnapshotsSequence

@available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
struct QuerySnapshotsSequence : AsyncSequence

An AsyncSequence that emits QuerySnapshot values whenever the query data changes.

This struct is the concrete type returned by the Query.snapshots property.

  • Declaration

    Swift

    public typealias Element = QuerySnapshot

  • Declaration

    Swift

    @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
public typealias Failure = Error

  • Declaration

    Swift

    public typealias AsyncIterator = Iterator

  • Creates a new sequence for monitoring query snapshots.

    Declaration

    Swift

    public init(_ query: Query, includeMetadataChanges: Bool)

    Parameters

    query

    The Query instance to monitor.
    includeMetadataChanges

    Whether to receive events for metadata-only changes.

  • Creates and returns an iterator for this asynchronous sequence.

    Declaration

    Swift

    public func makeAsyncIterator() -> Iterator

    Return Value

    An Iterator for QuerySnapshotsSequence.

  • The asynchronous iterator for QuerySnapshotsSequence.

    Declaration

    Swift

    @available(macOS 15.0, iOS 18.0, watchOS 11.0, tvOS 18.0, visionOS 2.0, *)
public struct Iterator : AsyncIteratorProtocol
     
    extension Query.QuerySnapshotsSequence.Iterator: Sendable