Poq.SDK.Node

Home > @poq/sdk-sfcc > ContentSearchRefinementValue

ContentSearchRefinementValue class

Document representing a search refinement value.

Signature:

export declare class ContentSearchRefinementValue extends BaseModel<ContentSearchRefinementValue> 

Extends: BaseModel<ContentSearchRefinementValue

Constructors

Constructor Modifiers Description
(constructor)(params)   Constructs a new instance of the ContentSearchRefinementValue class

Properties

Property Modifiers Type Description
description?   string (Optional) The localized description of the refinement value.
hitCount?   number (Optional) The number of search hits (0 or more) when selecting the refinement value.
label?   string (Optional) The localized label of the refinement value.
presentationId?   string (Optional) The optional presentation id associated with the refinement value. The presentation id can be used, for example, to associate an id with an HTML widget.
value?   string (Optional) The refinement value. In the case of an attribute refinement, this is the bucket, the attribute value, or a value range. In the case of a content folder refinement, this is the folder id.
values?   Array<ContentSearchRefinementValue> (Optional) The array of hierarchical refinement values. This array can be empty.