public class

SnapshotMetadata

extends Object
java.lang.Object
   ↳ com.google.firebase.firestore.SnapshotMetadata

Class Overview

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.

Summary

Public Methods
boolean equals(Object obj)
boolean hasPendingWrites()
int hashCode()
boolean isFromCache()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public boolean hasPendingWrites ()

Returns
boolean 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 int hashCode ()

Returns
int

public boolean isFromCache ()

Returns
boolean 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.