aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firestore/CHANGELOG.md
diff options
context:
space:
mode:
authorGravatar Michael Lehenbauer <mikelehen@gmail.com>2017-12-15 14:56:03 -0800
committerGravatar GitHub <noreply@github.com>2017-12-15 14:56:03 -0800
commitd4de7a6e86476991e2363dd09f623b2f0edfbee4 (patch)
tree182dfb0a5143b9465f9f01d7424982da8d0a775d /Firestore/CHANGELOG.md
parent98e08bc0b883d24cf2a0e658924ddd14dbf07d65 (diff)
b/68276665: Raise isFromCache=true events when offline (#567)
* Plumbs FSTOnlineState changes through to views. * View sets this.current to false on FSTOnlineStateFailed, triggering isFromCache=true events. It will automatically be returned to true once the listen is reestablished and we get a new CURRENT message. * Updated tests (and added one new one) to verify behavior. * Unifies setOnlineStateToUnknown, setOnlineStateToHealthy, and updateAndBroadcastOnlineState into a single updateOnlineState method. * Split disableNetwork into (public) disableNetwork and (private) disableNetworkWithTargetOnlineState methods.. * Some miscellaneous comment cleanup. * Add missing comment per CR feedback.
Diffstat (limited to 'Firestore/CHANGELOG.md')
-rw-r--r--Firestore/CHANGELOG.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/Firestore/CHANGELOG.md b/Firestore/CHANGELOG.md
index 8daae91..59858e6 100644
--- a/Firestore/CHANGELOG.md
+++ b/Firestore/CHANGELOG.md
@@ -1,4 +1,4 @@
-# Unreleased
+# Unreleased (firestore-api-changes)
- [changed] Removed the includeMetadataChanges property in FIRDocumentListenOptions
to avoid confusion with the factory method of the same name.
- [changed] Added a commit method that takes no completion handler to FIRWriteBatch.
@@ -8,6 +8,11 @@
- [changed] For non-existing documents, DocumentSnapshot.data() now returns `nil`
instead of throwing an exception. A non-nullable QueryDocumentSnapshot is
introduced for Queries to reduce the number of nil-checks in your code.
+- [changed] Snapshot listeners (with the `includeMetadataChanges` option
+ enabled) now receive an event with `snapshot.metadata.isFromCache` set to
+ `true` if the SDK loses its connection to the backend. A new event with
+ `snapshot.metadata.isFromCache` set to false will be raised once the
+ connection is restored and the query is in sync with the backend again.
# v0.9.4
- [changed] Firestore no longer has a direct dependency on FirebaseAuth.