Options
All
  • Public
  • Public/Protected
  • All
Menu

An interaction event is one that is triggered by a user in some way. This could be either an active action, such as a click, or a passive action, such as hovering over a UI element.

Some actions lead to results, such as following an artist, in which case the action name is used to tie the interaction and result events together.

Hierarchy

Index

Properties

Optional action_name

action_name: ActionName

In case the interaction will lead to a result, this should be the action name that will be used to associate the interaction to the result.

action_type

action_type: ActionType

The type of interaction that this event represents. E.g. Click.

NOTE: In the old Force schema, this was the event’s name.

Optional destination_path

destination_path: undefined | string

In case of a link, the location that it points to.

NOTE: This is old Force schema.

Optional flow

flow: undefined | string

Optional subject

subject: undefined | string

A description of the UI element that describes it inside the page/module. This is e.g. the label of the UI element.

Generated using TypeDoc