Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

SnapshotCreatedEvent

• webVis API Reference
• SnapshotCreatedEvent

Class SnapshotCreatedEvent

SNAPSHOT_CREATED SNAPSHOT_CREATED

Hierarchy (View Summary)

• WebVisEvent
  • SnapshotCreatedEvent

Index

Constructors

constructor

Properties

id properties snapshotID transactionCode? transactionID? type?

Accessors

attachmentID name order

Constructors

constructor

• new SnapshotCreatedEvent(
      snapshotID: number,
      properties: SnapshotProperties,
      _attachmentId: number,
  ): SnapshotCreatedEvent

• The SNAPSHOT_CREATED event occurs if a Snapshot has been created.

  Parameters

  • snapshotID: number

    The ID of the Snapshot.
  • properties: SnapshotProperties
  • _attachmentId: number

  Returns SnapshotCreatedEvent

  Overrides WebVisEvent.constructor

Properties

id

id: number

The unique ID of the event.

Inherited from WebVisEvent.id

properties

properties: SnapshotProperties

snapshotID

snapshotID: number

The ID of the Snapshot.

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

Inherited from WebVisEvent.transactionCode

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Inherited from WebVisEvent.transactionID

Optionaltype

type?: EventType

The type of the event.

Inherited from WebVisEvent.type

Accessors

attachmentID

• get attachmentID(): number

• Returns number

  Deprecated

  attachmentID is deprecated, please use properties.thumbnail instead.

name

• get name(): string

• Returns string

  Deprecated

  name is deprecated, please use properties.name instead.

order

• get order(): number

• Returns number

  Deprecated

  order is deprecated, please use properties.order instead.