Support Menu

Class QueryEvents

This static class is there to contains the different string definition for all the events related to query.

Note that these events will only be triggered when the QueryController.executeQuery method is used, either directly or by using executeQuery

Index

Properties

Static buildingQuery

buildingQuery: string

Triggered when the query is being built.

This is typically where all components will contribute their part to the IQuery using the QueryBuilder.

All bound handlers will receive IBuildingQueryEventArgs as an argument.

The string value is buildingQuery.

type

{string}

Static deferredQuerySuccess

deferredQuerySuccess: string

Triggered after the main query success event has finished executing.

This is typically where facets will process the IGroupByResult and render themselves.

All bound handlers will receive IQuerySuccessEventArgs as an argument.

The string value is deferredQuerySuccess.

type

{string}

Static doneBuildingQuery

doneBuildingQuery: string

Triggered when the query is done being built.

This is typically where the facet will add it's IGroupByRequest to the IQuery.

All bound handlers will receive IDoneBuildingQueryEventArgs as an argument.

The string value is doneBuildingQuery.

type

{string}

Static duringFetchMoreQuery

duringFetchMoreQuery: string

Triggered when more results are being fetched on the Search API (think : infinite scrolling, or pager).

All bound handlers will receive IDuringQueryEventArgs as an argument.

The string value is duringFetchMoreQuery.

type

{string}

Static duringQuery

duringQuery: string

Triggered when the query is being executed on the Search API.

All bound handlers will receive IDuringQueryEventArgs as an argument.

The string value is duringQuery.

type

{string}

Static fetchMoreSuccess

fetchMoreSuccess: string

Triggered when a more results were successfully returned from the Search API. (think : infinite scrolling, or pager).

All bound handlers will receive IFetchMoreSuccessEventArgs as an argument.

The string value is fetchMoreSuccess.

type

{string}

Static newQuery

newQuery: string

Triggered when a new query is launched.

All bound handlers will receive INewQueryEventArgs as an argument.

The string value is newQuery.

type

{string}

Static noResults

noResults: string

Triggered when there is no result for a particular query.

All bound handlers will receive INoResultsEventArgs as an argument.

The string value is noResults.

type

{string}

Static preprocessMoreResults

preprocessMoreResults: string

Triggered before the QueryEvents.fetchMoreSuccess event.

This allows external code to modify the results before rendering them.

For example, the Folding component might use this event to construct a coherent parent child relationship between query results.

All bound handlers will receive IPreprocessResultsEventArgs as an argument.

The string value is preprocessMoreResults.

type

{string}

Static preprocessResults

preprocessResults: string

Triggered before the QueryEvents.querySuccess event.

This allows external code to modify the results before rendering them.

For example, the Folding component might use this event to construct a coherent parent child relationship between query results.

All bound handlers will receive IPreprocessResultsEventArgs as an argument.

The string value is preprocessResults.

type

{string}

Static queryError

queryError: string

Triggered when there was an error executing a query on the Search API.

All bound handlers will receive IQueryErrorEventArgs as an argument.

The string value is queryError.

type

{string}

Static querySuccess

querySuccess: string

Triggered when a query successfully returns from the Search API.

All bound handlers will receive IQuerySuccessEventArgs as an argument.

The string value is querySuccess.

type

{string}

Hierarchy

  • QueryEvents