ActiveItemEvent

Class ActiveItemEvent

ACTIVE_ITEM ACTIVE_ITEM

Hierarchy (View Summary)

Constructors

constructor

Properties

id itemID itemType transactionCode? transactionID? type? viewer

Constructors

constructor

  • new ActiveItemEvent(
        itemID: number,
        itemType: ActiveItemType,
        viewer: ViewerAPI,
    ): ActiveItemEvent

  • The ACTIVE_ITEM event indicates a change to the current active item.

    Parameters

    • itemID: number

      The ID of the item

    • itemType: ActiveItemType

      The type of the active item

    • viewer: ViewerAPI

      The viewer to which the active item relates.

    Returns ActiveItemEvent

Properties

id

id: number

The unique ID of the event.

itemID

itemID: number

The ID of the item

itemType

itemType: ActiveItemType

The type of the active item

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.

viewer

viewer: ViewerAPI

The viewer to which the active item relates.

Did you find this page useful? Please give it a rating:
★ ★ ★ ★ ★
Thank you for rating this page!
Any issues or feedback?
What kind of problem would you like to report?
Please tell us more about what's wrong: