new module:models/ProductSearchResult()
Constructs a new ProductSearchResult.
Document representing a product search result.
- Source:
Members
(inner) count :Number
The number of returned documents.
Type:
- Number
- Source:
(inner) data :Array.<Object>
Type:
- Array.<Object>
- Source:
(inner) fetch_date :Number
Type:
- Number
- Source:
(inner) hits :Array.<module:models/ProductSearchHit>
The sorted array of search hits. This array can be empty.
Type:
- Array.<module:models/ProductSearchHit>
- Source:
(inner) next :String
The URL of the next result page.
Type:
- String
- Source:
(inner) previous :String
The URL of the previous result page.
Type:
- String
- Source:
(inner) query :String
The query String that was searched for.
Type:
- String
- Source:
(inner) refinements :Array.<module:models/ProductSearchRefinement>
The sorted array of search refinements. This array can be empty.
Type:
- Source:
(inner) search_phrase_suggestions :module:models/Suggestion
The suggestion given by the system for the submitted search phrase.
Type:
- Source:
(inner) selected_refinements :Object.<String, String>
A map of selected refinement attribute id/value(s) pairs. The sorting order is the same as in request URL.
Type:
- Object.<String, String>
- Source:
(inner) selected_sorting_option :String
The id of the applied sorting option.
Type:
- String
- Source:
(inner) sorting_options :Array.<module:models/ProductSearchSortingOption>
The sorted array of search sorting options. This array can be empty.
Type:
- Source:
(inner) start :Number
The zero-based index of the first search hit to include in the result.
Type:
- Number
- Source:
(inner) total :Number
The total number of documents.
Type:
- Number
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/ProductSearchResult}
Constructs a ProductSearchResult from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/ProductSearchResult | Optional instance to populate. |
- Source:
Returns:
The populated ProductSearchResult instance.