Skip to main content
Version: v2

ISnapshotContents Interface

This API is deprecated and will be removed in a future release.

This is deprecated.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface ISnapshotContents

Properties​

PropertyAlertsTypeDescription
blobsBetaMap<string, ArrayBuffer>
latestSequenceNumberBetanumber | undefinedSequence number for the latest op/snapshot for the file in ODSP
opsBetaISequencedDocumentMessage[]
sequenceNumberBetanumber | undefinedSequence number of the snapshot
snapshotTreeBetaISnapshotTree

Property Details​

blobs​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

blobs: Map<string, ArrayBuffer>;

Type: Map<string, ArrayBuffer>

latestSequenceNumber​

Sequence number for the latest op/snapshot for the file in ODSP

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

latestSequenceNumber: number | undefined;

Type: number | undefined

ops​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

ops: ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]

sequenceNumber​

Sequence number of the snapshot

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

sequenceNumber: number | undefined;

Type: number | undefined

snapshotTree​

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

snapshotTree: ISnapshotTree;

Type: ISnapshotTree