IHubSearchOptions

Interface

Search Options

Properties

Property Type Notes
aggFields Optional string[]

Fields to return aggregations on

aggLimit Optional number

Maximum number of aggregations to return Portal API only supports a single value

aggregations Optional string[]

DEPRECATED

api Optional NamedApis | IApiDefinition

Specify API to call. Defaults to ArcGIS Online Portal API

authentication Optional UserSession

DEPRECATE in favor of requestOptions

bbox Optional string

Bounding box for the search (NOT IMPLEMENTED)

enrichments Optional Enrichments[]

DEPRECATED: Use include instead

fields Optional string

DEPRECATED

include Optional string[]

Objects or fields to include e.g. server.layers AS serverLayers

num Optional number

Maximum number of results to return, per-page

page Optional string

LEGACY. Use start and num instead

requestOptions Optional IHubRequestOptions

While hubSearch requires requestOptions, it is not marked required because that is a breaking change to this interface, which is still required while we implement hubSearch

site Optional IModel

DEPRECATED

sortField Optional string

What field should the results be sorted on

sortOrder Optional "desc" | "asc"

Sort direction

start Optional number

The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.


Interface defined in common/src/search/types/IHubSearchOptions.ts:12