SnapshotMetadata class

スナップショットに関するメタデータ。スナップショットの状態を記述する。

署名:

export declare class SnapshotMetadata 

プロパティ

プロパティ 修飾キー タイプ 説明
fromCache ブール値 スナップショットが最新のサーバーデータを保証するのではなく、キャッシュ データから作成された場合は true。リスナーが(SnapshotListenOptions を介して)メタデータの更新にオプトインしている場合は、クライアントがバックエンドから最新のデータを受け取ると、fromCache が false に設定された別のスナップショットを受け取ります。
hasPendingWrites ブール値 バックエンドにまだ commit されていないローカル書き込みの結果(set() 呼び出しや update() 呼び出しなど)がスナップショットに含まれている場合は true。リスナーが(SnapshotListenOptions を介して)メタデータの更新にオプトインしている場合は、書き込みがバックエンドに commit されると、hasPendingWrites が false である別のスナップショットを受け取ります。

メソッド

メソッド 修飾キー 説明
isEqual(other) この SnapshotMetadata が指定された値と等しい場合、true を返します。

SnapshotMetadata.fromCache

スナップショットが最新のサーバーデータを保証するのではなく、キャッシュ データから作成された場合は true。リスナーが(SnapshotListenOptions を介して)メタデータの更新にオプトインしている場合は、クライアントがバックエンドから最新のデータを受け取ると、fromCache が false に設定された別のスナップショットを受け取ります。

署名:

readonly fromCache: boolean;

SnapshotMetadata.hasPendingWrites 関数

バックエンドにまだ commit されていないローカル書き込みの結果(set() 呼び出しや update() 呼び出しなど)がスナップショットに含まれている場合は true。リスナーが(SnapshotListenOptions を介して)メタデータの更新にオプトインしている場合は、書き込みがバックエンドに commit されると、hasPendingWrites が false である別のスナップショットを受け取ります。

署名:

readonly hasPendingWrites: boolean;

SnapshotMetadata.isEqual()

この SnapshotMetadata が指定された値と等しい場合、true を返します。

署名:

isEqual(other: SnapshotMetadata): boolean;

パラメータ

パラメータ 説明
その他 SnapshotMetadata 比較対象の SnapshotMetadata

戻り値:

ブール値

この SnapshotMetadata が指定された値と等しい場合は true を返します。