SnapshotMetadata

public class SnapshotMetadata extends Object

Metadata about a snapshot, describing the state of the snapshot.

Subclassing Note: Firestore classes are not meant to be subclassed except for use in test mocks. Subclassing is not supported in production code and new SDK releases may break code that does so.

Public Method Summary

boolean
boolean

Inherited Method Summary

Public Methods

public boolean hasPendingWrites ()

Returns
  • true if the snapshot contains the result of local writes (e.g. set() or update() calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via `DocumentListenOptions` or `QueryListenOptions`) you will receive another snapshot with `hasPendingWrites()` equal to false once the writes have been committed to the backend.

public boolean isFromCache ()

Returns
  • true if the snapshot was created from cached data rather than guaranteed up-to-date server data. If your listener has opted into metadata updates (via `DocumentListenOptions` or `QueryListenOptions`) you will receive another snapshot with `isFomCache()` equal to false once the client has received up-to-date data from the backend.

Send feedback about...

Need help? Visit our support page.