Class: module:models/SuggestionResult

module:models/SuggestionResult()

new module:models/SuggestionResult()

Constructs a new SuggestionResult. Document representing a search suggestion result.

Source:

Members

(inner) brand_suggestions :module:models/Suggestion

Returns the suggested brands.

Type:
Source:

(inner) category_suggestions :module:models/Suggestion

Returns the suggested categories.

Type:
Source:

(inner) content_suggestions :module:models/Suggestion

Returns the suggested content.

Type:
Source:

(inner) custom_suggestions :module:models/Suggestion

Returns the suggested custom suggestions.

Type:
Source:

(inner) product_suggestions :module:models/Suggestion

Returns the suggested products.

Type:
Source:

(inner) query :String

The query phrase to search for.

Type:
  • String
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/SuggestionResult}

Constructs a SuggestionResult 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/SuggestionResult

Optional instance to populate.

Source:
Returns:

The populated SuggestionResult instance.

Type
module:models/SuggestionResult