Check if document synced

meirrosendorff · September 2, 2021, 11:24am

Hi
I have a mobile application that uses couchbase lite with a replicator. After saving a document is there any way to check if the document has synced.
I need a way of knowing if my application is actively replicating so that I can warn the user that there may be a delay in their data becoming visible on the server.

My best thought is to maintain a current time document on the server add check that the document is up to date.

Thank you, appreciate the assistance.

Sandy_Chuang · September 2, 2021, 5:12pm

@meirrosendorff
You can use AddDocumentReplicationListener in Replicator.

github.com

couchbase/couchbase-lite-ios/blob/master/Swift/Replicator.swift#L150-L162

    
      
          /// Adds a document replication event listener. The document replication events will be posted
          /// on the main queue.
          ///
          /// According to performance optimization in the replicator, the document replication listeners need to be added
          /// before starting the replicator. If the listeners are added after the replicator is started, the replicator needs to be
          /// stopped and restarted again to ensure that the listeners will get the document replication events.
          ///
          /// - Parameter listener: The listener to post document replication events.
          /// - Returns: An opaque listener token object for removing the listener.
          @discardableResult public func addDocumentReplicationListener(
              _ listener: @escaping (DocumentReplication) -> Void) -> ListenerToken {
              return self.addDocumentReplicationListener(withQueue: nil, listener);
          }

meirrosendorff · September 3, 2021, 8:04am

@Sandy_Chuang thank you for the quick response, I see you posted swift code, can I assume the same logic will work for android ?

Sandy_Chuang · September 3, 2021, 4:40pm

Yes @meirrosendorff
Please see
https://docs.couchbase.com/mobile/2.8.0/couchbase-lite-android/com/couchbase/lite/AbstractReplicator.html#addDocumentReplicationListener-com.couchbase.lite.DocumentReplicationListener-