Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

addRefinement

  • Adds a given refinement to the search.

    Parameters

    • field: string

      The field name for the refinement.

    • valueOrLow: any

      Either the value for a value refinement, or the low for a range refinement.

    • Default value high: any = null

      Either the high for a range refinement, or left out for a value refinement.

    Returns ResetPageAndAddRefinement

    • Actions with relevant data.

applyPastPurchaseSorts

applySorts

createComponentState

  • Adds state for a given tag or section to the ui store.

    Parameters

    • tagName: string

      The name of the tag or a unique identifier.

    • id: string

      The id of the component or a unique id to use.

    • Default value state: any = {}

      The state to add in the store.

    Returns CreateComponentState

    • Action with tagName, id, and state.

deselectPastPurchaseRefinement

  • In the past purcahse page, removes a given refinement based on navigationId and index.

    Parameters

    • navigationId: string

      The navigationId for the navigation to fetch more refinements against.

    • index: number

      The index of the refinement intended to be selected.

    Returns PastPurchaseDeselect

    • Actions with relevant data.

deselectRefinement

fetchAutocompleteProducts

fetchAutocompleteSuggestions

fetchCollectionCount

fetchMorePastPurchaseProducts

fetchMorePastPurchaseRefinements

fetchMoreProducts

  • fetchMoreProducts(options: MoreProducts): any
  • fetchMoreProducts(amount: number, forward?: boolean): any
  • Makes a request for additional products beyond currently requested products.

    Parameters

    • options: MoreProducts

      An object with the amount and forward values, and a request object for override

    Returns any

    • Action with { amount, forward, request }.
  • Makes a request for additional products beyond currently requested products.

    Parameters

    • amount: number

      Amount of more products to fetch.

    • Optional forward: boolean

      true to fetch forward

    Returns any

    • Action with { amount, forward }.

fetchMoreRefinements

fetchPastPurchaseProducts

fetchPastPurchases

fetchProductDetails

fetchProducts

fetchProductsWhenHydrated

fetchProductsWithoutHistory

fetchRecommendationsProducts

fetchSaytPastPurchases

infiniteScrollRequestState

receiveAutocompleteProductRecords

receiveAutocompleteProducts

  • receiveAutocompleteProducts(res: Results): (Anonymous function)

receiveAutocompleteSuggestions

receiveAutocompleteTemplate

receiveCollectionCount

receiveDetails

receiveMorePastPurchaseProducts

  • receiveMorePastPurchaseProducts(res: Results): (Anonymous function)

receiveMorePastPurchaseRefinements

  • The more past purchase refinements to receive and update state with.

    Parameters

    • navigationId: string

      The navigation the more refinements correspond to.

    • refinements: Refinement[]

      The more refinements.

    • selected: number[]

      The selected array, indicating which indexes of the refinements are set to selected.

    Returns ReceiveMorePastPurchaseRefinements

    • Action with navigationId, refinements, and selected.

receiveMoreProducts

  • receiveMoreProducts(res: Results): (Anonymous function)
  • The more products to receive and update state with. Products will be added on to the products array in the store.

    Parameters

    • res: Results

    Returns (Anonymous function)

    • Action with products.

receiveMoreRefinements

  • The more refinements to receive and update state with.

    Parameters

    • navigationId: string

      The navigation the more refinements correspond to.

    • refinements: Refinement[]

      The more refinements.

    • selected: number[]

      The selected array, indicating which indexes of the refinements are set to selected.

    Returns ReceiveMoreRefinements

    • Action with navigationId, refinements, and selected.

receiveNavigationSort

receiveNavigations

receivePage

  • receivePage(recordCount: number, current?: number): (Anonymous function)

receivePastPurchaseAllRecordCount

receivePastPurchaseCurrentRecordCount

receivePastPurchasePage

  • receivePastPurchasePage(recordCount: number, current?: number, pageSize?: number): (Anonymous function)
  • The page to receive and update state with.

    Parameters

    • recordCount: number

      The current recordCount.

    • Optional current: number

      The current page.

    • Optional pageSize: number

    Returns (Anonymous function)

    • Action with page.

receivePastPurchaseProducts

receivePastPurchaseRefinements

receivePastPurchaseSiteParams

receivePastPurchaseSkus

receivePastPurchaseTemplate

receiveProductRecords

receiveProducts

  • receiveProducts(res: Results): (Anonymous function)

receiveQuery

receiveRecommendationsProducts

receiveRecordCount

receiveRedirect

receiveSaytPastPurchases

receiveSiteParams

receiveTemplate

refreshState

removeComponentState

resetAndSelectPastPurchaseRefinement

resetPage

resetPastPurchasePage

resetPastPurchaseQueryAndSelectRefinement

  • Removes the current past purchase query and selects the given past purchase refinement.

    Parameters

    • navigationId: string

      The navigationId for the refinement intending to be selected.

    • index: number

      The index of the refinement to be selected in the store.

    Returns PastPurchaseQueryAndSelect

    • Actions with payloads.

resetPastPurchaseRefinements

  • In the past purchase page, removes the selected refinements from the search.

    Parameters

    • Optional field: boolean | string

      true to reset all refinements, or navigationId to reset all refinements on a specific navigation.

    Returns PastPurchaseReset

    • Actions with relevant data.

resetQuery

resetRecall

  • resetRecall(query?: string, __namedParameters?: object): (Anonymous function)
  • Performs a new search with query or selected refinement, and resets recallId.

    Parameters

    • Default value query: string = null

      The query to use in the search.

    • Default value __namedParameters: object = <any>{}
      • field: string

        The navigation for the refinement to select.

      • index: number

        The index for the refinement.

    Returns (Anonymous function)

    • Actions with relevant data.

resetRefinements

search

  • search(query?: string): (Anonymous function)
  • Performs search with query, removes current refinements.

    Parameters

    • Optional query: string

      Search term to perform search with. If not supplied, search with current query is performed, removing current refinements.

    Returns (Anonymous function)

    • Actions with relevant data.

selectCollection

selectMultiplePastPurchaseRefinements

  • In the past purchase section, selects the given refinements based on navigationId and indices.

    Parameters

    • navigationId: string

      The navigationId for the navigation to fetch more refinements against.

    • indices: number[]

      The indices of the refinements intended to be selected.

    Returns PastPurchaseSelectMultiple

    • Actions with relevant data.

selectMultipleRefinements

selectPastPurchaseRefinement

  • In the past purchase section, selects a given refinement based on navigationId and index.

    Parameters

    • navigationId: string

      The navigationId for the navigation to fetch more refinements against.

    • index: number

      The index of the refinement intended to be selected.

    Returns PastPurchaseSelect

    • Actions with relevant data.

selectPastPurchasesSort

selectRefinement

selectSort

setSessionId

startApp

startRedirect

stopRedirect

switchRefinement

  • switchRefinement(field: string, valueOrLow: any, high?: any): SwitchRefinement
  • Removes all refinements for a given navigation field and adds the given refinement to the search.

    Parameters

    • field: string

      The field name for the navigation.

    • valueOrLow: any

      Either the value for a value refinement, or the low for a range refinement.

    • Default value high: any = null

      Either the high for a range refinement, or left out for a value refinement.

    Returns SwitchRefinement

    • Actions with relevant data.

updateAutocompleteQuery

updateBiasing

  • updateBiasing(payload: Biasing): (Anonymous function)

updateCurrentPage

updateDetails

updateHistory

updateLocation

updatePageSize

updatePastPurchaseCurrentPage

updatePastPurchasePageSize

updatePastPurchaseQuery

updateQuery

updateSearch

  • updateSearch(newSearch: Search): (Anonymous function)

updateSecuredPayload

Generated using TypeDoc