Class SearchService

Hierarchy

BaseService
- SearchService

Index

Constructors

Properties

baseUrl fieldMappings queryStringParams searchUrl variantFieldMappings

Accessors

Constructors

constructor

new SearchService(): SearchService
Returns SearchService

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

addFacetValue

addFacetValue(field, value): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

bindComponents

bindComponents(searchResponse): void
Parameters
- searchResponse: SearchResponse
Returns void

bindConceptSearchFieldComponent

bindConceptSearchFieldComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindFacetsListComponent

bindFacetsListComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindImageSearchFieldComponent

bindImageSearchFieldComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindLandingPageComponent

bindLandingPageComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindModifiedQueryComponent

bindModifiedQueryComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindPageSizeComponent

bindPageSizeComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindPaginationComponent

bindPaginationComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindQuerySuggestionsComponent

bindQuerySuggestionsComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSearchFieldComponent

bindSearchFieldComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSearchResultsComponent

bindSearchResultsComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSearchResultsListComponent

bindSearchResultsListComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSelectedFacetsComponent

bindSelectedFacetsComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSmartResponseComponent

bindSmartResponseComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSortingComponent

bindSortingComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindTabsComponent

bindTabsComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindZoneComponent

bindZoneComponent(searchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

excludeFacetValue

excludeFacetValue(field, value): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

`Protected` generateGuid

generateGuid(): string
Returns string

Inherited from BaseService.generateGuid

`Protected` getFullUrl

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

Inherited from BaseService.getFullUrl

`Protected` getNumber

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

Inherited from BaseService.getNumber

getRequestFromUrl

getRequestFromUrl(): SearchRequest
Returns SearchRequest

`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

`Protected` getVisitId

getVisitId(): string
Returns string

Inherited from BaseService.getVisitId

`Protected` 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

includeFacetValue

includeFacetValue(field, value): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

paginate

paginate(page): Promise<SearchResponse>
Parameters
- page: number
Returns Promise<SearchResponse>

query

query(query?, selectedFacets?, disableSpellcheck?): Promise<void | SearchResponse>
Parameters
- Optional query: SearchTypes
- selectedFacets: undefined | SelectedFacets = undefined
- disableSpellcheck: boolean = false
Returns Promise<void | SearchResponse>

removeFacetValue

removeFacetValue(field, value): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

search

search(searchRequest): Promise<SearchResponse>
Parameters
- searchRequest: SearchRequest
Returns Promise<SearchResponse>

searchWithin

searchWithin(value): Promise<SearchResponse>
Parameters
- value: string
Returns Promise<SearchResponse>

selectTab

selectTab(value?): Promise<SearchResponse>
Parameters
- Optional value: string
Returns Promise<SearchResponse>

setFacetValue

setFacetValue(field, value): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

setPageSize

setPageSize(pageSize): Promise<SearchResponse>
Parameters
- pageSize: number
Returns Promise<SearchResponse>

`Protected` setSeoElements

setSeoElements(searchResponse): void
Parameters
- searchResponse: SearchResponse
Returns void

sort

sort(value?): Promise<SearchResponse>
Parameters
- Optional value: string
Returns Promise<SearchResponse>

`Protected` stripHtml

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

Inherited from BaseService.stripHtml

`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