Stay organized with collections
Save and categorize content based on your preferences.
FIRSnapshotListenOptions
@interfaceFIRSnapshotListenOptions:NSObject
Options to configure the behavior of Firestore.addSnapshotListenerWithOptions(). Instances
of this class control settings like whether metadata-only changes trigger events and the
preferred data source.
Creates and returns a new SnapshotListenOptions object with all properties of the current
SnapshotListenOptions object plus the new property specifying whether metadata-only changes
should trigger snapshot events
Creates and returns a new SnapshotListenOptions object with all properties of the current
SnapshotListenOptions object plus the new property specifying the source that the snapshot
listener listens to.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-11 UTC."],[],[],null,["# FirebaseFirestore Framework Reference\n\nFIRSnapshotListenOptions\n========================\n\n\n @interface FIRSnapshotListenOptions : NSObject\n\nOptions to configure the behavior of `Firestore.addSnapshotListenerWithOptions()`. Instances\nof this class control settings like whether metadata-only changes trigger events and the\npreferred data source.\n- `\n ``\n ``\n `\n\n ### [source](#/c:objc(cs)FIRSnapshotListenOptions(py)source)\n\n `\n ` \n The source the snapshot listener retrieves data from. \n\n #### Declaration\n\n Objective-C \n\n @property (nonatomic, readonly) ../Enums/FIRListenSource.html source;\n\n- `\n ``\n ``\n `\n\n ### [includeMetadataChanges](#/c:objc(cs)FIRSnapshotListenOptions(py)includeMetadataChanges)\n\n `\n ` \n Indicates whether metadata-only changes should trigger snapshot events. \n\n #### Declaration\n\n Objective-C \n\n @property (nonatomic, readonly) BOOL includeMetadataChanges;\n\n- `\n ``\n ``\n `\n\n ### [-init](#/c:objc(cs)FIRSnapshotListenOptions(im)init)\n\n `\n ` \n Creates and returns a new `SnapshotListenOptions` object with all properties initialized to their\n default values. \n\n #### Declaration\n\n Objective-C \n\n - (nonnull instancetype)init;\n\n #### Return Value\n\n The created `SnapshotListenOptions` object.\n- `\n ``\n ``\n `\n\n ### [-optionsWithIncludeMetadataChanges:](#/c:objc(cs)FIRSnapshotListenOptions(im)optionsWithIncludeMetadataChanges:)\n\n `\n ` \n Creates and returns a new `SnapshotListenOptions` object with all properties of the current\n `SnapshotListenOptions` object plus the new property specifying whether metadata-only changes\n should trigger snapshot events \n\n #### Declaration\n\n Objective-C \n\n - (nonnull FIRSnapshotListenOptions *)optionsWithIncludeMetadataChanges:\n (BOOL)includeMetadataChanges;\n\n #### Return Value\n\n The created `SnapshotListenOptions` object.\n- `\n ``\n ``\n `\n\n ### [-optionsWithSource:](#/c:objc(cs)FIRSnapshotListenOptions(im)optionsWithSource:)\n\n `\n ` \n Creates and returns a new `SnapshotListenOptions` object with all properties of the current\n `SnapshotListenOptions` object plus the new property specifying the source that the snapshot\n listener listens to. \n\n #### Declaration\n\n Objective-C \n\n - (nonnull FIRSnapshotListenOptions *)optionsWithSource:(../Enums/FIRListenSource.html)source;\n\n #### Return Value\n\n The created `SnapshotListenOptions` object."]]
