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.