Class SearchPhraseSuggestions

The search phrase suggestions contain a list of suggested search phrases (see SuggestedPhrase) as well as, for each of the search phrase terms, a list with corrected and completed alternative terms.

Property Summary 

PropertyDescription
suggestedPhrases: Iterator (read-only)Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
suggestedTerms: Iterator (read-only)Returns a list of SuggestedTerms objects.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getSuggestedPhrases()Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
getSuggestedTerms()Returns a list of SuggestedTerms objects.
hasSuggestedPhrases()Returns whether this suggestions container has any suggested phrases.
hasSuggestedTerms()Returns whether this suggestions container has any suggested terms.

Methods inherited from class Object 

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

Property Details 

suggestedPhrases 

suggestedPhrases: Iterator (read-only)

Returns a list of SuggestedPhrase objects that relates to the user input search phrase.

See Also:


suggestedTerms 

suggestedTerms: Iterator (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.

See Also:


Method Details 

getSuggestedPhrases() 

getSuggestedPhrases(): Iterator

Returns a list of SuggestedPhrase objects that relates to the user input search phrase.

Returns:

See Also:


getSuggestedTerms() 

getSuggestedTerms(): Iterator

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:

  • a list of SuggestedTerms for each term of the user input search phrase

See Also:


hasSuggestedPhrases() 

hasSuggestedPhrases(): Boolean

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.

Returns:

  • true only if there are phrases available

hasSuggestedTerms() 

hasSuggestedTerms(): Boolean

Returns whether this suggestions container has any suggested terms.

Note that this method checks suggested terms only, but not suggested phrases.

Returns:

  • true only if there are terms available

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!