Class KeywordQuery

Contains information about a keyword based search query.

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(context: ClientContext): KeywordQuery

Parameters

Returns

KeywordQuery

Properties

public getQuerySuggestionsWithResults: (iNumberOfQuerySuggestions: number, iNumberOfResultSuggestions: number, fPreQuerySuggestions: boolean, fHitHighlighting: boolean, fCapitalizeFirstLetters: boolean, fPrefixMatchAllTerms: boolean) => Microsoft.SharePoint.Client.Search.Query.QuerySuggestionResults

public get_blockDedupeMode: () => number

public get_bypassResultTypes: () => boolean

public get_clientType: () => string

public get_collapseSpecification: () => string

public get_culture: () => number

public get_desiredSnippetLength: () => number

public get_enableInterleaving: () => boolean

public get_enableNicknames: () => boolean

public get_enableOrderingHitHighlightedProperty: () => boolean

public get_enablePhonetic: () => boolean

public get_enableQueryRules: () => boolean

public get_enableSorting: () => boolean

public get_enableStemming: () => boolean

public get_generateBlockRankLog: () => boolean

public get_hiddenConstraints: () => string

public get_hitHighlightedMultivaluePropertyLimit: () => number

public get_hitHighlightedProperties: () => Microsoft.SharePoint.Client.Search.Query.StringCollection

public get_ignoreSafeQueryPropertiesTemplateUrl: () => boolean

public get_impressionID: () => string

public get_maxSnippetLength: () => number

public get_personalizationData: () => Microsoft.SharePoint.Client.Search.Query.QueryPersonalizationData

public get_processBestBets: () => boolean

public get_processPersonalFavorites: () => boolean

public get_properties: () => Microsoft.SharePoint.Client.Search.Query.KeywordQueryProperties

public get_queryTag: () => string

public get_queryTemplate: () => string

public get_queryTemplateParameters: () => { [key: string]: boolean; }

public get_queryText: () => string

public get_rankingModelId: () => string

public get_refinementFilters: () => Microsoft.SharePoint.Client.Search.Query.StringCollection

public get_refiners: () => string

public get_reorderingRules: () => Microsoft.SharePoint.Client.Search.Query.ReorderingRuleCollection

public get_resultsUrl: () => string

public get_rowLimit: () => number

public get_rowsPerPage: () => number

public get_safeQueryPropertiesTemplateUrl: () => string

public get_selectProperties: () => Microsoft.SharePoint.Client.Search.Query.StringCollection

Specifies the list of managed properties to be returned for each search result.

public get_showPeopleNameSuggestions: () => boolean

public get_sortList: () => Microsoft.SharePoint.Client.Search.Query.SortCollection

public get_sourceId: () => SP.Guid

public get_startRow: () => number

public get_summaryLength: () => number

public get_timeout: () => number

public get_totalRowsExactMinimum: () => number

public get_trimDuplicates: () => boolean

public get_trimDuplicatesIncludeId: () => number

public get_uiLanguage: () => number

public set_blockDedupeMode: (value: number) => void

public set_bypassResultTypes: (value: boolean) => void

public set_clientType: (value: string) => void

public set_collapseSpecification: (value: string) => void

public set_culture: (value: number) => void

public set_desiredSnippetLength: (value: number) => void

public set_enableInterleaving: (value: boolean) => void

public set_enableNicknames: (value: boolean) => void

public set_enableOrderingHitHighlightedProperty: (value: boolean) => void

public set_enablePhonetic: (value: boolean) => void

public set_enableQueryRules: (value: boolean) => void

public set_enableSorting: (value: boolean) => void

public set_enableStemming: (value: boolean) => void

public set_generateBlockRankLog: (value: boolean) => void

public set_hiddenConstraints: (value: string) => void

public set_hitHighlightedMultivaluePropertyLimit: (value: number) => void

public set_ignoreSafeQueryPropertiesTemplateUrl: (value: boolean) => void

public set_impressionID: (value: string) => void

public set_maxSnippetLength: (value: number) => void

public set_personalizationData: (QueryPersonalizationData: any) => void

public set_processBestBets: (value: boolean) => void

public set_processPersonalFavorites: (value: boolean) => void

public set_queryTag: (value: string) => void

public set_queryTemplate: (value: string) => void

public set_queryText: (value: string) => void

public set_rankingModelId: (value: string) => void

public set_refinementFilters: (value: Microsoft.SharePoint.Client.Search.Query.StringCollection) => void

public set_refiners: (value: string) => void

public set_reorderingRules: (value: Microsoft.SharePoint.Client.Search.Query.ReorderingRuleCollection) => void

public set_resultsUrl: (value: string) => void

public set_rowLimit: (value: number) => void

public set_rowsPerPage: (value: number) => void

public set_safeQueryPropertiesTemplateUrl: (value: string) => void

public set_showPeopleNameSuggestions: (value: boolean) => void

public set_sourceId: (value: SP.Guid) => void

public set_startRow: (value: number) => void

public set_summaryLength: (number: any) => void

public set_timeout: (value: number) => void

public set_totalRowsExactMinimum: (value: number) => void

public set_trimDuplicates: (value: boolean) => void

public set_trimDuplicatesIncludeId: (value: number) => void

public set_uiLanguage: (value: number) => void

Methods

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public fromJson(initValue: any)

Parameters

  • initValue: any

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public set_objectVersion(value: string)

Parameters

  • value: string