SnapshotProperties

Interface SnapshotProperties

Represents the properties of a snapshot.

These properties define the metadata and state of a snapshot, such as its name, order, thumbnail, and status.

Use Case

Use this type to manage and retrieve metadata about snapshots. For example, you can use it to display snapshot details in the UI or to determine the consistency of a snapshot.

See

SessionStorageAPI

interface SnapshotProperties {
    name?: string;
    order?: number;
    status?: SnapshotStatus;
    thumbnail?: string;
}

Properties

name? order? status? thumbnail?

Properties

Optionalname

name?: string

The name of the snapshot. This property represents the user-defined name of the snapshot.

Default

undefined

Optionalorder

order?: number

The order of the snapshot in the list of all snapshots.

Default

undefined

Optional Readonlystatus

status?: SnapshotStatus

Describes the availability and integrity status of a snapshot's referenced data. See SnapshotStatus for more information about the possible values.

Default

SnapshotStatus.CONSISTENT
@readonly

Optional Readonlythumbnail

thumbnail?: string

The thumbnail of the snapshot as a Base64-encoded JPG or PNG image. This property provides a visual representation of the snapshot.

Default

undefined
@readonly