Class TrackingService

Hierarchy

BaseService
- TrackingService

Constructors

constructor

new TrackingService(): TrackingService
Returns TrackingService

Inherited from BaseService.constructor

Properties

`Protected` baseUrl

baseUrl: string = ...

`Protected` fieldMappings

fieldMappings: ServiceFieldMappings

queryStringParams

queryStringParams: {
    disableSpellcheck: string;
    page: string;
    pageSize: string;
    query: string;
    requestType: string;
    searchWithin: string;
    sort: string;
} = ...

Type declaration

disableSpellcheck: string
page: string
pageSize: string
query: string
requestType: string
searchWithin: string
sort: string

searchUrl

searchUrl: string = ...

`Protected` variantFieldMappings

variantFieldMappings: ServiceVariantFieldMappings

Accessors

`Protected` onSearchPage

get onSearchPage(): boolean
Returns boolean

Inherited from BaseService.onSearchPage

Methods

`Protected` generateGuid

generateGuid(): string
Returns string

Inherited from BaseService.generateGuid

`Protected` getApiHeaders

getApiHeaders(): Headers
Returns headers with X-HawkSearch-ClientGuid, X-Forwarded-For, and User-Agent for API calls.

Returns Headers

Inherited from BaseService.getApiHeaders

`Protected` getFullUrl

getFullUrl(url, prefix): undefined | string
Parameters
- url: undefined | string
- prefix: undefined | string
Returns undefined | string

Inherited from BaseService.getFullUrl

`Protected` getHeaders

getHeaders(): Headers
Returns Headers

Inherited from BaseService.getHeaders

`Protected` getNumber

getNumber(data, fieldMappings, defaultValue?): undefined | number
Parameters
- data: object
- fieldMappings: string[]
- Optional defaultValue: number
Returns undefined | number

Inherited from BaseService.getNumber

`Protected` getString

getString(data, fieldMappings, defaultValue?): undefined | string
Parameters
- data: object
- fieldMappings: string[]
- Optional defaultValue: string
Returns undefined | string

Inherited from BaseService.getString

`Protected` getUrl

getUrl(data, fieldMappings, prefix?): undefined | string
Parameters
- data: object
- fieldMappings: string[]
- Optional prefix: string
Returns undefined | string

Inherited from BaseService.getUrl

`Protected` getValue

getValue(data, fieldMappings): undefined | string[]
Parameters
- data: object
- fieldMappings: string[]
Returns undefined | string[]

Inherited from BaseService.getValue

`Protected` getVariants

getVariants(document): {
items: undefined | ItemVariant[];
selectedItem?: ItemVariant;
}
Parameters
- document: RawVariantDocument
Returns {
items: undefined | ItemVariant[];
selectedItem?: ItemVariant;
}
- items: undefined | ItemVariant[]
- Optional selectedItem?: ItemVariant
Inherited from BaseService.getVariants

getVisitId

getVisitId(): string
Returns string

Inherited from BaseService.getVisitId

getVisitorId

getVisitorId(): string
Returns string

Inherited from BaseService.getVisitorId

`Protected` httpPost

httpPost<T>(relativeUrl, body?, customHeaders?, isAbsoluteUrl?): Promise<T>
Type Parameters
- T
Parameters
- relativeUrl: string
- Optional body: any
- Optional customHeaders: any
- Optional isAbsoluteUrl: boolean
Returns Promise<T>

Inherited from BaseService.httpPost

`Protected` stripHtml

stripHtml(input): string
Parameters
- input: string
Returns string

Inherited from BaseService.stripHtml

trackAddToCart

trackAddToCart(productId, quantity, price, currencyIsoCode): Promise<void>
Parameters
- productId: string
- quantity: number
- price: number
- currencyIsoCode: string
Returns Promise<void>

trackAddToCartMultiple

trackAddToCartMultiple(items): Promise<void>
Parameters
- items: {
      currencyIsoCode: string;
      price: number;
      productId: string;
      quantity: number;
  }[]
Returns Promise<void>

trackAutocompleteClick

trackAutocompleteClick(query, itemType, title, url): Promise<void>
Parameters
- query: undefined | string
- itemType: AutocompleteItemType
- title: string
- url: string
Returns Promise<void>

trackBannerClick

trackBannerClick(bannerId, campaignId): Promise<void>
Parameters
- bannerId: number
- campaignId: number
Returns Promise<void>

trackBannerImpression

trackBannerImpression(bannerId, campaignId): Promise<void>
Parameters
- bannerId: number
- campaignId: number
Returns Promise<void>

trackEvent

trackEvent(type, data): Promise<void>
Parameters
- type: EventType
- data: any
Returns Promise<void>

trackOrder

trackOrder(orderId, items, subTotal, tax, total, currencyIsoCode): Promise<void>
Parameters
- orderId: string
- items: {
      price: number;
      productId: string;
      quantity: number;
  }[]
- subTotal: number
- tax: number
- total: number
- currencyIsoCode: string
Returns Promise<void>

trackPageLoad

trackPageLoad(pageType, productId?): Promise<void>
Parameters
- pageType: PageType
- Optional productId: string
Returns Promise<void>

trackRating

trackRating(productId, rating): Promise<void>
Parameters
- productId: string
- rating: number
Returns Promise<void>

trackRecommendationClick

trackRecommendationClick(widgetId, requestId, productId): Promise<void>
Parameters
- widgetId: string
- requestId: string
- productId: string
Returns Promise<void>

trackSearch

trackSearch(query, newSearch): Promise<void>
Parameters
- query: undefined | string
- newSearch: boolean
Returns Promise<void>

trackSearchResultClick

trackSearchResultClick(id, url, event?): Promise<void>
Parameters
- id: string
- url: string
- Optional event: PointerEvent
Returns Promise<void>

`Protected` triggerBindEvent

triggerBindEvent<T>(component, data, filter?): void
Type Parameters
- T
Parameters
- component: keyof HawkSearchComponents
- data: T
- Optional filter: string
Returns void

Inherited from BaseService.triggerBindEvent

`Protected` triggerEvent

triggerEvent<T>(name, data): void
Type Parameters
- T
Parameters
- name: string
- data: T
Returns void

Inherited from BaseService.triggerEvent