Interface IQuery

Index

Properties

Optional actionsHistory

actionsHistory: string

Optional allowQueriesWithoutKeywords

allowQueriesWithoutKeywords: boolean

Optional aq

aq: string

Optional categoryFacets

categoryFacets: ICategoryFacetRequest[]

Optional childField

childField: string

Optional commerce

Optional context

context: Context

Optional cq

cq: string

Optional debug

debug: boolean

Optional dq

dq: string

Optional enableCollaborativeRating

enableCollaborativeRating: boolean

Optional enableDidYouMean

enableDidYouMean: boolean

Optional enableQuerySyntax

enableQuerySyntax: boolean

Optional excerptLength

excerptLength: number

Optional facetOptions

facetOptions: IFacetOptions

Optional facets

facets: IFacetRequest[]

Optional fieldsToExclude

fieldsToExclude: string[]

Optional fieldsToInclude

fieldsToInclude: string[]

Optional filterField

filterField: string

Optional filterFieldRange

filterFieldRange: number

Optional firstResult

firstResult: number

Optional format

Optional groupBy

groupBy: IGroupByRequest[]

Optional lowercaseOperators

lowercaseOperators: boolean

Optional lq

lq: string

Optional maximumAge

maximumAge: number

Optional numberOfResults

numberOfResults: number

Optional parentField

parentField: string

Optional partialMatch

partialMatch: boolean

Optional partialMatchKeywords

partialMatchKeywords: number

Optional partialMatchThreshold

partialMatchThreshold: string

Optional pipeline

pipeline: string

q

q: string

Optional queryFunctions

queryFunctions: IQueryFunction[]

Optional questionMark

questionMark: boolean

Optional rankingFunctions

rankingFunctions: IRankingFunction[]

Optional recommendation

recommendation: string

Optional retrieveFirstSentences

retrieveFirstSentences: boolean

Optional searchHub

searchHub: string

Optional sortCriteria

sortCriteria: string

Optional tab

tab: string

Optional userActions

userActions: IUserActionsRequest

Optional wildcards

wildcards: boolean

Hierarchy

  • IQuery