Search

Search something to see results

RumImpression

Implements

Index

Constructors

Types.RumImpression.constructor

Methods

Types.RumImpression.appendTypes.RumImpression.calculateRelativeTypes.RumImpression.getBeaconIndexTypes.RumImpression.getDataByKeyTypes.RumImpression.getPiIdTypes.RumImpression.getTrackedDataTypes.RumImpression.initCustomDimensionDataTypes.RumImpression.initCustomTimerDataTypes.RumImpression.initEnforcedTopLevelAttributesTypes.RumImpression.reportEventTypes.RumImpression.sendCollapsedTypes.RumImpression.sendCurrentTrackingTypes.RumImpression.setTypes.RumImpression.setTimingTypes.RumImpression.trackCustomEventTypes.RumImpression.trackCustomTimerTypes.RumImpression.updateBaseDimension

Constructors

new RumImpression(
    baseDimensions: BaseDimensions,
    userData: UserData,
    navigationType: RumNavigationType,
    leavePageHandler: LeavePageHandler,
    piTimeoutHandler: PiTimeoutHandler,
): RumImpression

Parameters

Returns RumImpression

Methods

append(key: string, data: TrackingData, immediately?: boolean): void

Appends the given data to the given key for tracking. This method can be called multiple times to add multiple data items to the key.

Parameters

Returns void

calculateRelative(timer: number): number

Calculates a given timer relative to the navigation start.

Parameters

  • timer: number

Returns number

getBeaconIndex(): number

Returns the current beacon index or 0 if no beacon has been sent yet.

Returns number

getDataByKey(key: string): TrackingData

Returns the unsent or sent tracking data for a given key.

Parameters

  • key: string

Returns TrackingData

getPiId(): string

Returns the pi id of this impression.

Returns string

getTrackedData(): TrackingObject

Public method to get the current tracked RUM data

Returns TrackingObject

initCustomDimensionData(plugins: RumPlugin<TrackingData>[]): void

Initialises the custom dimension data which is used for this site.

Parameters

Returns void

initCustomTimerData(plugins: RumPlugin<TrackingData>[]): void

Initialises the custom timer data which is used for this site.

Parameters

Returns void

initEnforcedTopLevelAttributes(plugins: RumPlugin<TrackingData>[]): void

Initialises enforced top level attributes by applying the default value if no plugin was found which handles the tracking.

Parameters

Returns void

reportEvent(
    eventKey: string,
    eventStart: number,
    durationKey?: string,
    eventEnd?: number,
): void

Calculates the time values compared with the start of the navigation. In case of a time range the start and the duration is calculated in milliseconds.

Parameters

  • eventKey: string
  • eventStart: number
  • OptionaldurationKey: string
  • OptionaleventEnd: number

Returns void

sendCollapsed(): void

Ensures that multiple calls to send Method will be collapsed if user is not leaving the site.

Returns void

sendCurrentTracking(unloadType?: string): void

Sends a beacon with the currently unsent data.

Parameters

  • OptionalunloadType: string

Returns void

set(
    key: string,
    data: TrackingData,
    immediately?: boolean,
    mode?: boolean | SendMode,
): boolean

Sets the given data to the given key for tracking. Calling this method multiple times will override old value. To track multiple values per key use append

Parameters

Returns boolean

true if value is scheduled to be sent with the next beacons, false otherwise.

setTiming(
    key: string,
    data: TrackingData,
    immediately?: boolean,
    mode?: boolean | SendMode,
): boolean

Sets the given data to the given key for tracking relatively to the navigationStart when it is numeric. Otherwise it will be tracked normal. Calling this method multiple times will override old value. To track multiple values (without being calculated relatively) per key use append.

Parameters

Returns boolean

true if value is scheduled to be sent with the next beacons, false otherwise.

trackCustomEvent(
    action: string,
    label: string,
    value: number,
    immediately?: boolean,
    withTimestamp?: boolean,
): void

Send custom event information (action, label and value) using a beacon.

Parameters

  • action: string
  • label: string
  • value: number
  • immediately: boolean = true
  • withTimestamp: boolean = true

Returns void

trackCustomTimer(key: string, data: TrackingData, immediately?: boolean): void

Sends custom timer information (key and data) using a beacon.

Parameters

Returns void

updateBaseDimension(
    dimension: keyof BaseDimensions,
    newValue: string | number,
): void

Updates a value of the base dimensions, which will be sent with every tracking beacon.

Parameters

Returns void