new module:models/ContentSearchResult()
Constructs a new ContentSearchResult.
Document representing a content search result.
- Source:
Members
(inner) count :Number
The number of returned documents.
Type:
- Number
- Source:
(inner) data :Array.<Object>
Type:
- Array.<Object>
- Source:
(inner) hits :Array.<module:models/Content>
The sorted array of search hits. Can be empty.
Type:
- Array.<module:models/Content>
- 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/ContentSearchRefinement>
The sorted array of search refinements. Can be empty.
Type:
- Source:
(inner) selected_refinements :Object.<String, String>
Map of selected refinement attribute id/value(s) pairs. The sorting order is the same like in request URL.
Type:
- Object.<String, String>
- 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/ContentSearchResult}
Constructs a ContentSearchResult 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/ContentSearchResult | Optional instance to populate. |
- Source:
Returns:
The populated ContentSearchResult instance.