diff options
author | Gil <mcg@google.com> | 2018-04-15 16:56:43 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-04-15 16:56:43 -0700 |
commit | 4de2d80e4371e50419823961789424d40561f75a (patch) | |
tree | df0248786efd946233490508557d10faf2021554 /Firestore/Source/Public/FIRQuery.h | |
parent | 5368c9e22f9a6b427466e9422645d688953013c0 (diff) |
Replace `QueryListenOptions` with simple booleans (#1106)
* Replace `QueryListenOptions` with simple booleans
Instead of calling
addSnapshotListener(
options:QueryListenOptions.includeQueryMetadataChanges()
.includeDocumentMetadataChanges())
call
addSnapshotListener(includeMetadataChanges:true)
Also change `QuerySnapshot.documentChanges()` into a method which
optionally takes `includeMetadataChanges:true`. By default even when
listening to a query with `inlcudeMetadataChanges:true` metadata-only
document changes are suppressed because they're confusing.
* Revert QuerySnapshot.documentChanges back to a property
Add usage.
Diffstat (limited to 'Firestore/Source/Public/FIRQuery.h')
-rw-r--r-- | Firestore/Source/Public/FIRQuery.h | 51 |
1 files changed, 6 insertions, 45 deletions
diff --git a/Firestore/Source/Public/FIRQuery.h b/Firestore/Source/Public/FIRQuery.h index ff15ac6..a28af39 100644 --- a/Firestore/Source/Public/FIRQuery.h +++ b/Firestore/Source/Public/FIRQuery.h @@ -25,46 +25,6 @@ NS_ASSUME_NONNULL_BEGIN -/** - * Options for use with `[FIRQuery addSnapshotListener]` to control the behavior of the snapshot - * listener. - */ -NS_SWIFT_NAME(QueryListenOptions) -@interface FIRQueryListenOptions : NSObject - -+ (instancetype)options NS_SWIFT_UNAVAILABLE("Use initializer"); - -- (instancetype)init; - -@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. - * - * @param includeQueryMetadataChanges Whether to raise events for metadata-only changes on the - * query. - * @return The receiver is returned for optional method chaining. - */ -- (instancetype)includeQueryMetadataChanges:(BOOL)includeQueryMetadataChanges - NS_SWIFT_NAME(includeQueryMetadataChanges(_:)); - -@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. - * - * @param includeDocumentMetadataChanges Whether to raise events for document metadata-only changes. - * @return The receiver is returned for optional method chaining. - */ -- (instancetype)includeDocumentMetadataChanges:(BOOL)includeDocumentMetadataChanges - NS_SWIFT_NAME(includeDocumentMetadataChanges(_:)); - -@end - typedef void (^FIRQuerySnapshotBlock)(FIRQuerySnapshot *_Nullable snapshot, NSError *_Nullable error); @@ -103,16 +63,17 @@ NS_SWIFT_NAME(Query) /** * Attaches a listener for QuerySnapshot events. * - * @param options Options controlling the listener behavior. + * @param includeMetadataChanges Whether metadata-only changes (i.e. only + * `FIRDocumentSnapshot.metadata` changed) should trigger snapshot events. * @param listener The listener to attach. * * @return A FIRListenerRegistration that can be used to remove this listener. */ // clang-format off -- (id<FIRListenerRegistration>)addSnapshotListenerWithOptions: - (nullable FIRQueryListenOptions *)options - listener:(FIRQuerySnapshotBlock)listener - NS_SWIFT_NAME(addSnapshotListener(options:listener:)); +- (id<FIRListenerRegistration>) +addSnapshotListenerWithIncludeMetadataChanges:(BOOL)includeMetadataChanges + listener:(FIRQuerySnapshotBlock)listener + NS_SWIFT_NAME(addSnapshotListener(includeMetadataChanges:listener:)); // clang-format on #pragma mark - Filtering Data |