Class TrackingService

Hierarchy (View Summary)

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;
} = ...

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: string | undefined,
prefix: string | undefined,
): string | undefined
Parameters
- url: string | undefined
- prefix: string | undefined
Returns string | undefined
Inherited from BaseService.getFullUrl

`Protected`getHeaders

getHeaders(): Headers
Returns Headers
Inherited from BaseService.getHeaders

`Protected`getNumber

getNumber(
    data: object,
    fieldMappings: string[],
    defaultValue?: number,
): number | undefined
Parameters
- data: object
- fieldMappings: string[]
- OptionaldefaultValue: number
Returns number | undefined
Inherited from BaseService.getNumber

`Protected`getString

getString(
    data: object,
    fieldMappings: string[],
    defaultValue?: string,
): string | undefined
Parameters
- data: object
- fieldMappings: string[]
- OptionaldefaultValue: string
Returns string | undefined
Inherited from BaseService.getString

`Protected`getUrl

getUrl(
    data: object,
    fieldMappings: string[],
    prefix?: string,
): string | undefined
Parameters
- data: object
- fieldMappings: string[]
- Optionalprefix: string
Returns string | undefined
Inherited from BaseService.getUrl

`Protected`getValue

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

getVisitId

getVisitId(): string
Returns string
Inherited from BaseService.getVisitId

getVisitorId

getVisitorId(): string
Returns string
Inherited from BaseService.getVisitorId

`Protected`httpPost

httpPost<T>(
    relativeUrl: string,
    body?: any,
    customHeaders?: any,
    isAbsoluteUrl?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- relativeUrl: string
- Optionalbody: any
- OptionalcustomHeaders: any
- OptionalisAbsoluteUrl: boolean
Returns Promise<T>
Inherited from BaseService.httpPost

`Protected`stripHtml

stripHtml(input: string): string
Parameters
- input: string
Returns string
Inherited from BaseService.stripHtml

trackAddToCart

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

trackAddToCartMultiple

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

trackAutocompleteClick

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

trackBannerClick

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

trackBannerImpression

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

trackEvent

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

trackOrder

trackOrder(
    orderId: string,
    items: { price: number; productId: string; quantity: number }[],
    subTotal: number,
    tax: number,
    total: number,
    currencyIsoCode: string,
): 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: PageType, productId?: string): Promise<void>
Parameters
- pageType: PageType
- OptionalproductId: string
Returns Promise<void>

trackRating

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

trackRecommendationClick

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

trackSearch

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

trackSearchResultClick

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

`Protected`triggerBindEvent

triggerBindEvent<T>(
    component: keyof HawkSearchComponents,
    data: T,
    filter?: string,
): void
Type Parameters
- T
Parameters
- component: keyof HawkSearchComponents
- data: T
- Optionalfilter: string
Returns void
Inherited from BaseService.triggerBindEvent

`Protected`triggerEvent

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