ISnapshot Interface
Packages > @fluidframework/driver-definitions > ISnapshot
A “Full” container Snapshot, including ISnapshotTree, blobs and outstanding ops (and other metadata)
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface ISnapshot
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| blobContents |
Alpha
|
Map<string, ArrayBuffer> | |
| latestSequenceNumber |
Alpha
|
number | undefined | Sequence number for the latest op/snapshot for the file in ODSP |
| ops |
Alpha
|
ISequencedDocumentMessage[] | |
| sequenceNumber |
Alpha
|
number | undefined | Sequence number of the snapshot |
| snapshotFormatV |
Alpha
|
1 | |
| snapshotTree |
Alpha
|
ISnapshotTree |
Property Details
blobContents
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
blobContents: Map<string, ArrayBuffer>;
Type: Map<string, ArrayBuffer>
latestSequenceNumber
Sequence number for the latest op/snapshot for the file in ODSP
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
latestSequenceNumber: number | undefined;
Type: number | undefined
ops
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
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 as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
sequenceNumber: number | undefined;
Type: number | undefined
snapshotFormatV
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
snapshotFormatV: 1;
Type: 1
snapshotTree
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
snapshotTree: ISnapshotTree;
Type: ISnapshotTree