Metadane dotyczące migawki, opisujące stan migawki.
Podpis:
export declare class SnapshotMetadata
Nieruchomości
Nieruchomość | Modyfikatory | Typ | Opis |
---|---|---|---|
z pamięci podręcznej | wartość logiczna | Prawda, jeśli migawka została utworzona na podstawie danych buforowanych, a nie gwarantowanych aktualnych danych serwera. Jeśli Twój słuchacz zgodził się na aktualizacje metadanych (poprzez SnapshotListenOptions ), otrzymasz kolejną migawkę z fromCache ustawioną na false, gdy klient otrzyma aktualne dane z zaplecza. | |
ma oczekujące zapisy | wartość logiczna | Prawda, jeśli migawka zawiera wynik lokalnych zapisów (na przykład wywołań set() lub update() ), które nie zostały jeszcze zatwierdzone w zapleczu. Jeśli Twój słuchacz zgodził się na aktualizacje metadanych (poprzez SnapshotListenOptions ), otrzymasz kolejną migawkę z hasPendingWrites równą false po zatwierdzeniu zapisów w backendie. |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
jest równy (inne) | Zwraca wartość true, jeśli wartość SnapshotMetadata jest równa podanej. |
SnapshotMetadata.fromCache
Prawda, jeśli migawka została utworzona na podstawie danych buforowanych, a nie gwarantowanych aktualnych danych serwera. Jeśli Twój słuchacz zgodził się na aktualizacje metadanych (za pośrednictwem SnapshotListenOptions
) otrzymasz kolejną migawkę z fromCache
ustawioną na false, gdy klient otrzyma aktualne dane z backendu.
Podpis:
readonly fromCache: boolean;
SnapshotMetadata.hasPendingWrites
Prawda, jeśli migawka zawiera wynik lokalnych zapisów (na przykład wywołań set()
lub update()
), które nie zostały jeszcze zatwierdzone w zapleczu. Jeśli Twój słuchacz zgodził się na aktualizacje metadanych (za pośrednictwem SnapshotListenOptions
) otrzymasz kolejną migawkę z hasPendingWrites
równą false po zatwierdzeniu zapisów w backendie.
Podpis:
readonly hasPendingWrites: boolean;
SnapshotMetadata.isEqual()
Zwraca wartość true, jeśli wartość SnapshotMetadata
jest równa podanej.
Podpis:
isEqual(other: SnapshotMetadata): boolean;
Parametry
Parametr | Typ | Opis |
---|---|---|
Inny | SnapshotMetadane | SnapshotMetadata do porównania. |
Zwroty:
wartość logiczna
true , jeśli te SnapshotMetadata
są równe podanemu.