Home > @poq/sdk-sfcc > ContentSearchResult
Document representing a content search result.
Signature:
export declare class ContentSearchResult extends BaseModel<ContentSearchResult>
Extends: BaseModel<ContentSearchResult
Constructor | Modifiers | Description |
---|---|---|
(constructor)(params) | Constructs a new instance of the ContentSearchResult class |
Property | Modifiers | Type | Description |
---|---|---|---|
count? | number | (Optional) The number of returned documents. | |
data? | Array<object> | (Optional) | |
hits? | Array<Content> | (Optional) The sorted array of search hits. Can be empty. | |
next? | string | (Optional) The URL of the next result page. | |
previous? | string | (Optional) The URL of the previous result page. | |
query? | string | (Optional) The query String that was searched for. | |
refinements? | Array<ContentSearchRefinement> | (Optional) The sorted array of search refinements. Can be empty. | |
selectedRefinements? | { [key: string]: string; } | (Optional) Map of selected refinement attribute id/value(s) pairs. The sorting order is the same like in request URL. | |
start? | number | (Optional) The zero-based index of the first search hit to include in the result. | |
total? | number | (Optional) The total number of documents. |