This is the base class for suggestions containers. For each type of items, a sub class provides methods to access the actual items.
See the sub classes for more specific information.
BrandSuggestions, CategorySuggestions, ContentSuggestions, CustomSuggestions, ProductSuggestions
| Property | Description |
|---|---|
searchPhraseSuggestions: SearchPhraseSuggestions (read-only) | Returns the suggested search phrases that are associated to this suggestions. |
(read-only) | Returns a list of SuggestedPhrase objects that relates to the user input search phrase. |
(read-only) | Returns a list of SuggestedTerms objects. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getSearchPhraseSuggestions() | Returns the suggested search phrases that are associated to this suggestions. |
| Returns a list of SuggestedPhrase objects that relates to the user input search phrase. | |
| Returns a list of SuggestedTerms objects. | |
| Returns whether this suggestions container has any suggested phrases. | |
| Returns whether this suggestions container has any suggested terms. | |
| hasSuggestions() | Returns whether this suggestions container has any suggested items, i.e. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns the suggested search phrases that are associated to this suggestions.
In contrast to the suggested items, the suggested phrases contains the corrected and completed versions of the original search phrase.
(read-only)Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
See Also:
Deprecated:
Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
Warning
(read-only)Returns a list of SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.
Deprecated:
Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
Warning
Returns the suggested search phrases that are associated to this suggestions.
In contrast to the suggested items, the suggested phrases contains the corrected and completed versions of the original search phrase.
Returns:
Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
Returns:
See Also:
Deprecated:
Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
Warning
Returns a list of SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.
Returns:
Deprecated:
Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
Warning
Returns whether this suggestions container has any suggested phrases.
Note that this method only looks for suggested phrases. It does not account for suggested terms or suggested objects. In other words, even if there are suggested terms or objects, this method will return false if this suggestions container has no phrases.
Returns:
Deprecated:
Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
Warning
Returns whether this suggestions container has any suggested terms.
Note that this method checks suggested terms only, but not suggested phrases or suggested objects.
Returns:
Deprecated:
Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
Warning
Returns whether this suggestions container has any suggested items, i.e. products.
Note that this method only looks for concrete suggested items. It does not account for suggested terms. In other words, even if there are suggested terms, this method will return false if no matching items, like products or categories, were found for the suggested terms.
To find out whether there are suggested terms and how they match with respect to the original search phrase, one can use getSuggestedTerms() to obtain a list of SuggestedTerms.
Returns:
See Also:
j