FIRSnapshotMetadata

@interface FIRSnapshotMetadata : NSObject

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

  • Undocumented

    Declaration

    Objective-C

    @interface FIRSnapshotMetadata : NSObject
  • Returns YES 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 FIRDocumentListenOptions or FIRQueryListenOptions) you will receive another snapshot with hasPendingWrites equal to NO once the writes have been committed to the backend.

    Declaration

    Swift

    var hasPendingWrites: Bool { get }

    Objective-C

    @property (readonly, getter=hasPendingWrites, assign, nonatomic)
        BOOL pendingWrites;
  • Returns YES 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 FIRDocumentListenOptions or FIRQueryListenOptions) you will receive another snapshot with isFromCache equal to NO once the client has received up-to-date data from the backend.

    Declaration

    Swift

    var isFromCache: Bool { get }

    Objective-C

    @property (readonly, getter=isFromCache, assign, nonatomic) BOOL fromCache;