File

libs/ngx-pfe/models/tracking-config.model.ts

Index

Properties

Properties

event
event: string
Type : string
Optional

Event name to be used in event. If this is not configured, the stateKeyExpression without $. is used.

ignorePageId
ignorePageId: boolean
Type : boolean
Optional

Forward the ignorePageId flag to trackify.

stateKeyExpression
stateKeyExpression: JsonPathExpression
Type : JsonPathExpression

JsonPathExpression of the key in the state that will be watched. Every time this key changes, a tracking event will be fired.

import { JsonPathExpression } from './jsonpath-expression-type.model';

export interface TrackingConfig {
  /**
   * Allows it to configure a set of state keys that are watched.
   * Changing values are pushed as tracking events.
   *
   * Be careful, not to configure too many keys here as that might
   * have an impact on the performance
   */
  stateTracking?: StateValueTracking[];
}

export interface StateValueTracking {
  /**
   * JsonPathExpression of the key in the state that will be watched.
   * Every time this key changes, a tracking event will be fired.
   */
  stateKeyExpression: JsonPathExpression;

  /**
   * Event name to be used in event. If this is not configured, the stateKeyExpression
   * without $. is used.
   */
  event?: string;

  /**
   * Forward the ignorePageId flag to trackify.
   */
  ignorePageId?: boolean;
}

results matching ""

    No results matching ""