Cancel any pending query
Return the debug info about this component.
Disable the component. Normally this means that the component will not execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Enable the component. Normally this means that the component will execute handlers for the framework events (query events, for example). Components are enabled by default on creation.
Execute a query and return a Promise of IQueryResults.
This will execute the normal query flow, triggering all the necessary query events (newQuery
All components present in the interface will act accordingly (modify the query and render results if needed).
Using the same parameters as the last successful query, fetch another batch of results. Particularly useful for infinite scrolling, for example.
Returns the plan of execution of a search request, without executing it.
Get the SearchEndpoint that is currently used by the query controller to execute query
Return the last query that was performed by the query controller
Return the last query results set.
Set the SearchEndpoint that the query controller should use to execute query
A disabled component will not participate in the query, or listen to ComponentEvents.
Allows component to log in the dev console.
The static ID that each component needs in order to be identified.
For example, SearchButton -> static ID: SearchButton -> className: CoveoSearchButton
Create a new query controller
Deprecated. Since the October 2019 Release (v2.7219), the class retrieves and uses the {@link AnalyticsClient} from its searchInterface constructor parameter.
This class is automatically instantiated and bound to the root of your search interface when you initialize the framework.
It is essentially a singleton that wraps the access to the SearchEndpoint endpoint to execute query, and is in charge of triggering the different query events.
This is what every component of the framework uses internally to execute query or access the endpoint.
When calling
Coveo.executeQuerythis class is used.