FIRQueryListenOptions


@interface FIRQueryListenOptions : NSObject

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

  • Undocumented

    Declaration

    Objective-C

    + (instancetype)options NS_SWIFT_UNAVAILABLE("Use initializer");
  • Undocumented

    Declaration

    Swift

    init()

    Objective-C

    - (instancetype)init;
  • Undocumented

    Declaration

    Swift

    var includeQueryMetadataChanges: Bool { get }

    Objective-C

    @property(nonatomic, assign, readonly) BOOL includeQueryMetadataChanges
  • Sets the includeQueryMetadataChanges option which controls whether metadata-only changes on the query (i.e. only FIRQuerySnapshot.metadata changed) should trigger snapshot events. Default is NO.

    Declaration

    Swift

    func includeQueryMetadataChanges(_ includeQueryMetadataChanges: Bool) -> Self

    Objective-C

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

    Parameters

    includeQueryMetadataChanges

    Whether to raise events for metadata-only changes on the query.

    Return Value

    The receiver is returned for optional method chaining.

  • Undocumented

    Declaration

    Swift

    var includeDocumentMetadataChanges: Bool { get }

    Objective-C

    @property(nonatomic, assign, readonly) BOOL includeDocumentMetadataChanges
  • Sets the includeDocumentMetadataChanges option which controls whether document metadata-only changes (i.e. only FIRDocumentSnapshot.metadata on a document contained in the query changed) should trigger snapshot events. Default is NO.

    Declaration

    Swift

    func includeDocumentMetadataChanges(_ includeDocumentMetadataChanges: Bool) -> Self

    Objective-C

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

    Parameters

    includeDocumentMetadataChanges

    Whether to raise events for document metadata-only changes.

    Return Value

    The receiver is returned for optional method chaining.