SnapshotChangedEvent

• webVis API Reference
• SnapshotChangedEvent

Class SnapshotChangedEvent

SNAPSHOT_CHANGED SNAPSHOT_CHANGED

Hierarchy (View Summary)

• WebVisEvent
  • SnapshotChangedEvent

Index

Constructors

constructor

Properties

id properties snapshotID transactionCode? transactionID? type?

Accessors

order screenshot text

Constructors

constructor

• new SnapshotChangedEvent(
      snapshotID: number,
      properties: SnapshotProperties,
  ): SnapshotChangedEvent

• The SNAPSHOT_CHANGED event occurs if a Snapshot has been changed.

  Parameters

  • snapshotID: number

    The ID of the Snapshot.
  • properties: SnapshotProperties

    An object with the changed Properties.

  Returns SnapshotChangedEvent

  Overrides WebVisEvent.constructor

Properties

id

id: number

The unique ID of the event.

Inherited from WebVisEvent.id

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.

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

order

• get order(): number

• Returns number

  Deprecated

  order is deprecated, please use properties.order instead.

screenshot

• get screenshot(): string

• Returns string

  Deprecated

  screenshot is deprecated, please use properties.screenshot instead.

text

• get text(): string

• Returns string

  Deprecated

  text is deprecated, please use properties.name instead.