diff options
| author |  zxu <zxu@google.com> | 2017-12-08 09:22:56 -0500 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2017-12-08 09:22:56 -0500 |
| commit | 440014eb37be95491232ee6e519073bc2299eb90 (patch) | |
| tree | 6a02a4d09cf4b1ae172de68590c0e7b0aff7aa11 | |
| parent | c7bade7aba047d52201d650894fd91b198bce3ab (diff) | |
make FIRDocumentListenOptions.includeMetadataChanges private (#540)
* make FIRDocumentListenOptions.includeMetadataChanges private
as discussed in Firestore API discussion, the name clashes creates confusion. Android SDK already not exposing the property; here change iOS SDK to match it.
* update CHANGELOG
| -rw-r--r-- | Firestore/CHANGELOG.md | 2 | ||||
| -rw-r--r-- | Firestore/Source/API/FIRDocumentReference.m | 2 | ||||
| -rw-r--r-- | Firestore/Source/Public/FIRDocumentReference.h | 2 |
3 files changed, 4 insertions, 2 deletions
diff --git a/Firestore/CHANGELOG.md b/Firestore/CHANGELOG.md index e6ecf11..32cbbfc 100644 --- a/Firestore/CHANGELOG.md +++ b/Firestore/CHANGELOG.md @@ -1,5 +1,7 @@ # Unreleased - [changed] Firestore no longer has a direct dependency on FirebaseAuth. +- [changed] Removed the includeMetadataChanges property in FIRDocumentListenOptions + to avoid confusion with the factory method of the same name. - [fixed] Fixed a crash when using path names with international characters with persistence enabled. diff --git a/Firestore/Source/API/FIRDocumentReference.m b/Firestore/Source/API/FIRDocumentReference.m index 1c80ea9..6279b7c 100644 --- a/Firestore/Source/API/FIRDocumentReference.m +++ b/Firestore/Source/API/FIRDocumentReference.m @@ -48,6 +48,8 @@ NS_ASSUME_NONNULL_BEGIN - (instancetype)initWithIncludeMetadataChanges:(BOOL)includeMetadataChanges NS_DESIGNATED_INITIALIZER; +@property(nonatomic, assign, readonly) BOOL includeMetadataChanges; + @end @implementation FIRDocumentListenOptions diff --git a/Firestore/Source/Public/FIRDocumentReference.h b/Firestore/Source/Public/FIRDocumentReference.h index 439e727..7fcc7a8 100644 --- a/Firestore/Source/Public/FIRDocumentReference.h +++ b/Firestore/Source/Public/FIRDocumentReference.h @@ -36,8 +36,6 @@ NS_SWIFT_NAME(DocumentListenOptions) - (instancetype)init; -@property(nonatomic, assign, readonly) BOOL includeMetadataChanges; - /** * Sets the includeMetadataChanges option which controls whether metadata-only changes (i.e. only * `FIRDocumentSnapshot.metadata` changed) should trigger snapshot events. Default is NO. |