API Docs for: 2.0.20133.2
Show:

api.search.SearchConfig Class

Defined in: src\internal\api\search\searchConfig.ts:18
Module: API Search
Parent Module: API

Configuration for search api

Properties

count

Number

Defined in src\internal\api\search\searchConfig.ts:47

Total number of search results to be returned

enableHitHighlights

Boolean

Defined in src\internal\api\search\searchConfig.ts:83

Receive hitHighlights

environment

String

Defined in src\internal\api\search\searchConfig.ts:149

The API environment that should service the request

facets

SearchFacets

Defined in src\internal\api\search\searchConfig.ts:95

The desired search facets for the request

filter

SearchFilter

Defined in src\internal\api\search\searchConfig.ts:89

The desired search filters for the request

flights

String[]

Defined in src\internal\api\search\searchConfig.ts:125

The flights the call should use

includeInstantAnswers

Boolean

Defined in src\internal\api\search\searchConfig.ts:71

Receive instant answers along with search results

includeWebSearchResults

Boolean

Defined in src\internal\api\search\searchConfig.ts:77

Receive webSearchResults

insiderMode

String

Defined in src\internal\api\search\searchConfig.ts:107

Insider mode for on-boarding onto Alpha development

instantAnswerProvider

String

Defined in src\internal\api\search\searchConfig.ts:65

The desired instant answer provider for the request

locale

String

Defined in src\internal\api\search\searchConfig.ts:35

Locale for search results

muid

String

Defined in src\internal\api\search\searchConfig.ts:143

The muid of the user.

orderBy

SearchOrderByExpression

Defined in src\internal\api\search\searchConfig.ts:101

The desired search order by expressions for the request

query

String

Defined in src\internal\api\search\searchConfig.ts:29

Search query

query

String

Defined in src\internal\api\search\searchConfig.ts:23

HTTP Method to use ("GET" or "POST")

scopes

String

Defined in src\internal\api\search\searchConfig.ts:41

Comma delimited scopes for the search results

searchProvider

String

Defined in src\internal\api\search\searchConfig.ts:59

The desired search provider for the request

skip

Number

Defined in src\internal\api\search\searchConfig.ts:53

Number of search results returned for paging needs

suggestId

String

Defined in src\internal\api\search\searchConfig.ts:131

The search id used to track the virtual session

suggestId

String

Defined in src\internal\api\search\searchConfig.ts:137

The suggest id to correlate to the search

tenant

String

Defined in src\internal\api\search\searchConfig.ts:113

Use a specific tenant

version

String

Defined in src\internal\api\search\searchConfig.ts:119

Target a specific version