FirebaseFirestore Framework Reference

DocumentSnapshotsSequence

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

An AsyncSequence that emits DocumentSnapshot values whenever the document data changes.

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

• Element

  Declaration

  Swift

  public typealias Element = DocumentSnapshot

• Failure

  Declaration

  Swift

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

• AsyncIterator

  Declaration

  Swift

  public typealias AsyncIterator = Iterator

• init(_:includeMetadataChanges:)

  Creates a new sequence for monitoring document snapshots.

  Declaration

  Swift

  public init(_ documentReference: DocumentReference, includeMetadataChanges: Bool)

  Parameters

  documentReference	The DocumentReference instance to monitor.
  includeMetadataChanges	Whether to receive events for metadata-only changes.

• makeAsyncIterator()

  Creates and returns an iterator for this asynchronous sequence.

  Declaration

  Swift

  public func makeAsyncIterator() -> Iterator

  Return Value

  An Iterator for DocumentSnapshotsSequence.

• Iterator

  The asynchronous iterator for DocumentSnapshotsSequence.

  Declaration

  Swift

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

  extension DocumentReference.DocumentSnapshotsSequence.Iterator: Sendable