SnapshotChangedEvent

Class SnapshotChangedEvent

Event that is fired when a snapshot has been changed.

It provides the ID of the snapshot and the updated properties, allowing listeners to react to the changes.

Use Case

Use this event to monitor changes to snapshots, such as updates to their name, order, or thumbnail. This is particularly useful for keeping the UI or other components in sync with the latest snapshot state.

See

Hierarchy (View Summary)

Properties

id properties snapshotID transactionCode? transactionID? type?

Accessors

order screenshot text

Properties

id

id: number

The unique ID of the event.

properties

properties: SnapshotProperties

An object with the changed properties.

snapshotID

snapshotID: number

The ID of the Snapshot.

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Optionaltype

type?: EventType

The type of the event.

Accessors

order

  • get order(): number

  • Returns number

    The order of the snapshot.

    Deprecated

    order is deprecated, please use properties.order instead.

screenshot

  • get screenshot(): string

  • Returns string

    The screenshot image (thumbnail) of the snapshot.

    Deprecated

    screenshot is deprecated, please use properties.screenshot instead.

text

  • get text(): string

  • Returns string

    The name of the snapshot.

    Deprecated

    text is deprecated, please use properties.name instead.



Was this page helpful? Please leave a thumbs up or down.