Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SearchResultCollection

The list of search result items matching the criteria returned from the search operation. Search errors and messages, if any , will be part of the standard error response.

Properties

Functions

Properties

Optional count

count: undefined | number

Total number of items returned. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional facetedSearchAggregation

facetedSearchAggregation: Array<FacetedSearchAggregation>

Aggregations/facets on properties of data objects.

Optional items

items: Array<SearchResult>

Search result set.

Optional query

query: undefined | string

String that data objects are to be searched with.

Optional sortableFields

sortableFields: Array<string>

A list of fields or properties used in the sorting of a search result.

Functions

getDeserializedJsonObj

getJsonObj