Metadane dotyczące zrzutu opisujące jego stan.
Podpis:
export declare class SnapshotMetadata
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| fromCache (w pamięci podręcznej). | wartość logiczna | Prawda, jeśli zrzut został utworzony z danych w pamięci podręcznej, a nie z gwarantowanych aktualnych danych serwera. Jeśli detektor wyraził zgodę na aktualizacje metadanych (za pomocą SnapshotListenOptions), otrzymasz kolejny zrzut z opcją fromCache ustawioną na wartość Fałsz, gdy klient otrzyma aktualne dane z backendu. |
|
| hasPendingWrites, | wartość logiczna | Prawda, jeśli zrzut zawiera wynik lokalnych zapisów (np. wywołań funkcji set() lub update()), które nie zostały jeszcze zatwierdzone w backendzie. Jeśli detektor wyraził zgodę na aktualizacje metadanych (za pomocą SnapshotListenOptions), po zatwierdzeniu zapisów do backendu otrzymasz kolejny zrzut z wartością hasPendingWrites równą „false”. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| isEqual(other) | Zwraca wartość „prawda”, jeśli ta wartość SnapshotMetadata jest równa podanej wartości. |
SnapshotMetadata.fromCache
Prawda, jeśli zrzut został utworzony z danych w pamięci podręcznej, a nie z gwarantowanych aktualnych danych serwera. Jeśli detektor włączył aktualizacje metadanych (za pomocą SnapshotListenOptions), gdy klient otrzyma aktualne dane z backendu, otrzymasz kolejny zrzut z ustawieniem fromCache ustawionym na wartość Fałsz.
Podpis:
readonly fromCache: boolean;
SnapshotMetadata.hasPendingWrites
Prawda, jeśli zrzut zawiera wynik lokalnych zapisów (np. wywołań funkcji set() lub update()), które nie zostały jeszcze zatwierdzone w backendzie. Jeśli detektor wyraził zgodę na aktualizacje metadanych (za pomocą SnapshotListenOptions), po zatwierdzeniu zapisów do backendu otrzymasz kolejny zrzut z wartością hasPendingWrites równą false.
Podpis:
readonly hasPendingWrites: boolean;
SnapshotMetadata.isEqual()
Zwraca wartość „prawda”, jeśli ta wartość SnapshotMetadata jest równa podanej wartości.
Podpis:
isEqual(other: SnapshotMetadata): boolean;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| inne | SnapshotMetadata | SnapshotMetadata do porównania. |
Zwroty:
wartość logiczna
true (prawda), jeśli ta wartość SnapshotMetadata jest równa podanej wartości.