Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 2.38 KB

answers-headless.state.md

File metadata and controls

30 lines (22 loc) · 2.38 KB

Home > @yext/answers-headless > State

State interface

The state representing an AnswersHeadless instance.

Signature:

export interface State 

Properties

Property Type Description
directAnswer DirectAnswerState Maintains the direct answer associated with the latest search.
filters FiltersState Maintains the current state of facets and filters in the application.
location LocationState Maintains the user's location, if given, or the inferred location, that is used to bias search results.
meta MetaState Maintains the metadata for Answers Headless.
query QueryState Maintains the latest query and its associated data.
queryRules QueryRulesState Maintains the data from the triggered query rules.
searchStatus SearchStatusState Maintains the status of the latest search.
sessionTracking SessionTrackingState Maintains whether the user session should be tracked and, if so, the session information.
spellCheck SpellCheckState Maintains whether spellcheck is enabled and the spellcheck response from the latest search.
universal UniversalSearchState Maintains the data for the latest universal search.
vertical VerticalSearchState Maintains the data for the latest vertical search.