SnapshotMetadata class
Stay organized with collections
Save and categorize content based on your preferences.
Metadata about a snapshot, describing the state of the snapshot.
Signature:
export declare class SnapshotMetadata
Properties
| Property |
Modifiers |
Type |
Description |
| fromCache |
|
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 SnapshotListenOptions) you will receive another snapshot with fromCache set to false once the client has received up-to-date data from the backend. |
| hasPendingWrites |
|
boolean |
True if the snapshot contains the result of local writes (for example set() or update() calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via SnapshotListenOptions) you will receive another snapshot with hasPendingWrites equal to false once the writes have been committed to the backend. |
Methods
| Method |
Modifiers |
Description |
| isEqual(other) |
|
Returns true if this SnapshotMetadata is equal to the provided one. |
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 SnapshotListenOptions) you will receive another snapshot with fromCache set to false once the client has received up-to-date data from the backend.
Signature:
readonly fromCache: boolean;
True if the snapshot contains the result of local writes (for example set() or update() calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via SnapshotListenOptions) you will receive another snapshot with hasPendingWrites equal to false once the writes have been committed to the backend.
Signature:
readonly hasPendingWrites: boolean;
Returns true if this SnapshotMetadata is equal to the provided one.
Signature:
isEqual(other: SnapshotMetadata): boolean;
Parameters
| Parameter |
Type |
Description |
| other |
SnapshotMetadata |
The SnapshotMetadata to compare against. |
Returns:
boolean
true if this SnapshotMetadata is equal to the provided one.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-19 UTC.
[null,null,["Last updated 2024-01-19 UTC."],[],[],null,["# SnapshotMetadata class\n\nMetadata about a snapshot, describing the state of the snapshot.\n\n**Signature:** \n\n export declare class SnapshotMetadata \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|---------------------------------------------------------------------------------------|-----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [fromCache](./firestore_.snapshotmetadata.md#snapshotmetadatafromcache) | | 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 `SnapshotListenOptions`) you will receive another snapshot with `fromCache` set to false once the client has received up-to-date data from the backend. |\n| [hasPendingWrites](./firestore_.snapshotmetadata.md#snapshotmetadatahaspendingwrites) | | boolean | True if the snapshot contains the result of local writes (for example `set()` or `update()` calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via `SnapshotListenOptions`) you will receive another snapshot with `hasPendingWrites` equal to false once the writes have been committed to the backend. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|----------------------------------------------------------------------------|-----------|-----------------------------------------------------------------------|\n| [isEqual(other)](./firestore_.snapshotmetadata.md#snapshotmetadataisequal) | | Returns true if this `SnapshotMetadata` is equal to the provided one. |\n\nSnapshotMetadata.fromCache\n--------------------------\n\nTrue 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 `SnapshotListenOptions`) you will receive another snapshot with `fromCache` set to false once the client has received up-to-date data from the backend.\n\n**Signature:** \n\n readonly fromCache: boolean;\n\nSnapshotMetadata.hasPendingWrites\n---------------------------------\n\nTrue if the snapshot contains the result of local writes (for example `set()` or `update()` calls) that have not yet been committed to the backend. If your listener has opted into metadata updates (via `SnapshotListenOptions`) you will receive another snapshot with `hasPendingWrites` equal to false once the writes have been committed to the backend.\n\n**Signature:** \n\n readonly hasPendingWrites: boolean;\n\nSnapshotMetadata.isEqual()\n--------------------------\n\nReturns true if this `SnapshotMetadata` is equal to the provided one.\n\n**Signature:** \n\n isEqual(other: SnapshotMetadata): boolean;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|-----------------------------------------------------------------------------|--------------------------------------------|\n| other | [SnapshotMetadata](./firestore_.snapshotmetadata.md#snapshotmetadata_class) | The `SnapshotMetadata` to compare against. |\n\n**Returns:**\n\nboolean\n\ntrue if this `SnapshotMetadata` is equal to the provided one."]]
