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/CHANGELOG.md | |
| 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/CHANGELOG.md')
| -rw-r--r-- | Firestore/CHANGELOG.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Firestore/CHANGELOG.md b/Firestore/CHANGELOG.md index 00e16f5..4761a62 100644 --- a/Firestore/CHANGELOG.md +++ b/Firestore/CHANGELOG.md @@ -3,6 +3,16 @@ Instead of calling `addSnapshotListener(options: DocumentListenOptions.includeMetadataChanges(true))` call `addSnapshotListener(includeMetadataChanges:true)`. +- [changed] Replaced the `QueryListenOptions` object with simple booleans. + Instead of calling + `addSnapshotListener(options: + QueryListenOptions.includeQueryMetadataChanges(true) + .includeDocumentMetadataChanges(true))` + call `addSnapshotListener(includeMetadataChanges:true)`. +- [changed] `QuerySnapshot.documentChanges()` is now a method which optionally + takes `includeMetadataChanges:true`. By default even when listening to a + query with `includeMetadataChanges:true` metadata-only document changes are + suppressed in `documentChanges()`. - [changed] Replaced the `SetOptions` object with a simple boolean. Instead of calling `setData(["a": "b"], options: SetOptions.merge())` call `setData(["a": "b"], merge: true)`. |