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 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.

Hierarchy (View Summary)

Index

Properties

id properties snapshotID transactionCode? transactionID? type?

Accessors

attachmentID name order

Properties

id: number

The unique ID of the event.

properties: SnapshotProperties

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

snapshotID: number

The ID of the created snapshot.

transactionCode?: string

The transaction code associated with the event.

transactionID?: number

The transaction ID associated with the event.

type?: EventType

The type of the event.

Accessors

  • get attachmentID(): number

    Returns number

    The ID of the attachment associated with the snapshot.

    attachmentID is deprecated, please use properties.thumbnail instead.

  • get name(): string

    Returns string

    The name of the snapshot.

    name is deprecated, please use properties.name instead.

  • get order(): number

    Returns number

    The order of the snapshot.

    order is deprecated, please use properties.order instead.