Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DataPoint
    • Event

Index

Constructors

constructor

  • new Event(category: string | EventData, action?: string, name?: string, value?: number, campaignId?: string, times?: number, first?: Dayjs, last?: Dayjs): Event
  • Parameters

    • category: string | EventData
       The event category or an object containing all arguments. Must not be empty. (eg. Videos, Music, Games...)
      
    • Optional action: string
       The event action. Must not be empty. (eg. Play, Pause, Duration, Add Playlist, Downloaded, Clicked...)
       OPTIONAL if provided via an object as first argument.
      
    • Optional name: string
       The event name. OPTIONAL.
      
    • Optional value: number
       The event value. OPTIONAL.
      
    • Optional campaignId: string
       The campaign ID this data point is for.
       OPTIONAL if constructed with an object instead.
      
    • Optional times: number
    • Optional first: Dayjs
    • Optional last: Dayjs

    Returns Event

Properties

action

action: undefined | string

campaignId

campaignId: string

category

category: string

first

first: Dayjs

last

last: Dayjs

name

name: undefined | string

times

times: number

value

value: undefined | number

Methods

toString

  • toString(): string
  • Returns string

Generated using TypeDoc