SnapshotCreatedEventΒΆ

Class SnapshotCreatedEvent

Event that is fired when a snapshot has been successfully created. It provides information about the created snapshot, including its ID and properties.

Use Case

Use this event to monitor the creation of snapshots. This can be useful for updating the UI, displaying confirmation messages, or triggering additional workflows based on the created snapshot.

See

Hierarchy (View Summary)

Properties

id properties snapshotID transactionCode? transactionID? type?

Accessors

attachmentID name order

Properties

id

id: number

The unique ID of the event.

properties

properties: SnapshotProperties

The properties of the created snapshot, such as name, order, and thumbnail.

snapshotID

snapshotID: number

The ID of the created 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

attachmentID

  • get attachmentID(): number

  • Returns number

    The ID of the attachment associated with the snapshot.

    Deprecated

    attachmentID is deprecated, please use properties.thumbnail instead.

name

  • get name(): string

  • Returns string

    The name of the snapshot.

    Deprecated

    name is deprecated, please use properties.name instead.

order

  • get order(): number

  • Returns number

    The order of the snapshot.

    Deprecated

    order is deprecated, please use properties.order instead.