Class TrackerService

Hierarchy

BaseService<Options>
- TrackerService

Implements

Service

Index

Interfaces

Options

Constructors

constructor

Properties

Methods

Constructors

constructor

new TrackerService(app: StoreFront, opts: Options): TrackerService

Overrides BaseService.constructor
- Defined in core/src/services/tracker.ts:34
Parameters
- app: StoreFront
- opts: Options
Returns TrackerService

Properties

Protected app

app: StoreFront

client

client: GbTracker = new GbTracker(this.app.config.customerId, this.app.config.area)

Protected opts

transform

transform: function = ProductTransformer.transformer(this.app.config.structure)

Type declaration

- (product: any): any
- Parameters
  - product: any
  Returns any

Methods

addMetadata

addMetadata(event: any): any

- Defined in core/src/services/tracker.ts:154
Parameters
- event: any
Returns any

applyOptsOverride

applyOptsOverride<S, T>(defaultFn: function, override: Override<S, T>): (Anonymous function)

- Defined in core/src/services/tracker.ts:51
Type parameters
- S
- T
Parameters
- defaultFn: function
  - - (value: any, override?: Override<S, T>): void
    - Parameters
      - value: any
      - Optional override: Override<S, T>
      Returns void
- override: Override<S, T>
Returns (Anonymous function)

attachGbiEventMetadata

attachGbiEventMetadata<S>(override: S): S

- Defined in core/src/services/tracker.ts:78
Type parameters
- S: GbTracker.BaseEvent
Parameters
- override: S
Returns S

buildEvent

buildEvent<S, T>(override: Override<S, T>, event: T, value?: S | T): T

- Defined in core/src/services/tracker.ts:91
Type parameters
- S
- T
Parameters
- override: Override<S, T>
- event: T
- Default value value: S | T = event
Returns T

getMetadata

getMetadata(origin?: Tag): object[]

- Defined in core/src/services/tracker.ts:165
Parameters
- Default value origin: Tag = this.getSearchOrigin()
Returns object[]

getSearchOrigin

getSearchOrigin(): Tag

- Defined in core/src/services/tracker.ts:161
Returns Tag

init

init(): void

Overrides BaseService.init
- Defined in core/src/services/tracker.ts:42
Returns void

sendAddToCartEvent

sendAddToCartEvent(event: GbTracker.CartEvent, override?: Override<GbTracker.CartEvent, GbTracker.CartEvent>): void

- Defined in core/src/services/tracker.ts:118
Parameters
- event: GbTracker.CartEvent
- Default value override: Override<GbTracker.CartEvent, GbTracker.CartEvent> = (value, val) => val
Returns void

sendEvent

sendEvent(method: keyof GbTracker, event: any): void

- Defined in core/src/services/tracker.ts:69
Parameters
- method: keyof GbTracker
- event: any
Returns void

sendMoreRefinementsEvent

sendMoreRefinementsEvent(id: string, override?: Override<string, GbTracker.MoreRefinementsEvent>): void

- Defined in core/src/services/tracker.ts:148
Parameters
- id: string
- Default value override: Override<string, GbTracker.MoreRefinementsEvent> = (value, val) => val
Returns void

sendOrderEvent

sendOrderEvent(event: GbTracker.OrderEvent, override?: Override<GbTracker.OrderEvent, GbTracker.OrderEvent>): void

- Defined in core/src/services/tracker.ts:128
Parameters
- event: GbTracker.OrderEvent
- Default value override: Override<GbTracker.OrderEvent, GbTracker.OrderEvent> = (value, val) => val
Returns void

sendRemoveFromCartEvent

sendRemoveFromCartEvent(event: GbTracker.CartEvent, override?: Override<GbTracker.CartEvent, GbTracker.CartEvent>): void

- Defined in core/src/services/tracker.ts:123
Parameters
- event: GbTracker.CartEvent
- Default value override: Override<GbTracker.CartEvent, GbTracker.CartEvent> = (value, val) => val
Returns void

sendSearchEvent

sendSearchEvent(id: string, override?: Override<string, GbTracker.SearchEvent>): void

- Defined in core/src/services/tracker.ts:97
Parameters
- id: string
- Default value override: Override<string, GbTracker.SearchEvent> = (value, val) => val
Returns void

sendViewCartEvent

sendViewCartEvent(event: GbTracker.CartEvent, override?: Override<GbTracker.CartEvent, GbTracker.CartEvent>): void

- Defined in core/src/services/tracker.ts:113
Parameters
- event: GbTracker.CartEvent
- Default value override: Override<GbTracker.CartEvent, GbTracker.CartEvent> = (value, val) => val
Returns void

sendViewProductEvent

sendViewProductEvent(record: any, override?: Override<GbTracker.ViewProductEvent, GbTracker.ViewProductEvent>): void

- Defined in core/src/services/tracker.ts:133
Parameters
- record: any
- Default value override: Override<GbTracker.ViewProductEvent, GbTracker.ViewProductEvent> = (value, val) => val
Returns void

setListeners

setListeners(app: StoreFront): void

- Defined in core/src/services/tracker.ts:57
Parameters
- app: StoreFront
Returns void

Generated using TypeDoc