FIRDocumentListenOptions


@interface FIRDocumentListenOptions : NSObject

Options for use with [FIRDocumentReference addSnapshotListener] to control the behavior of the snapshot listener.

  • Undocumented

    Declaration

    Objective-C

    
    @interface FIRDocumentListenOptions : NSObject
  • Undocumented

    Declaration

    Objective-C

    
    @interface FIRDocumentListenOptions : NSObject
  • Undocumented

    Declaration

    Objective-C

    
    @interface FIRDocumentListenOptions : NSObject
  • Sets the includeMetadataChanges option which controls whether metadata-only changes (i.e. only FIRDocumentSnapshot.metadata changed) should trigger snapshot events. Default is NO.

    Declaration

    Swift

    func includeMetadataChanges(_ includeMetadataChanges: Bool) -> Self

    Objective-C

    - (nonnull instancetype)includeMetadataChanges:(BOOL)includeMetadataChanges;

    Parameters

    includeMetadataChanges

    Whether to raise events for metadata-only changes.

    Return Value

    The receiver is returned for optional method chaining.