IHubSearchOptions
Search Options
Properties
Property | Type | Notes |
---|---|---|
Optional | string[] |
Fields to return aggregations on |
Optional | number |
Maximum number of aggregations to return Portal API only supports a single value |
Optional | NamedApis | IApiDefinition |
Specify API to call. Defaults to ArcGIS Online Portal API |
Optional | UserSession |
DEPRECATE in favor of requestOptions |
Optional | string |
Bounding box for the search (NOT IMPLEMENTED) |
Optional | string[] |
Objects or fields to include e.g. |
Optional | number |
Maximum number of results to return, per-page |
Optional | string |
LEGACY. Use |
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 |
Optional | string |
What field should the results be sorted on |
Optional | "desc" | "asc" |
Sort direction |
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. |
Optional | EntityType |
Specify what entity to search for; For use with hubSearch |
Optional | boolean |
Enables experimental functionality. |
Interface defined in common/src/search/types/IHubSearchOptions.ts:14