ProviderQueryinterface
Describes the search query received by the search provider and provides methods for responding to it.
Properties (5)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| id⚓︎ | string | x | ID for the search query (assigned by the framework). |
|
| providerLimits⚓︎ | ProviderLimits | x | x | Specifies the maximum total results and/or the maximum results per search type to return. |
| providers⚓︎ | ProviderData[] | x | x | List of search providers to query. |
| search⚓︎ | string | x | String for which to query the search providers. |
|
| types⚓︎ | SearchType[] | x | x | List of search types in which the search client app is interested. |
3 Methods
error()⚓︎
(error: string) => void
Sends errors back to search clients.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| error⚓︎ | string | Error message to send back to search clients. |
sendResult()⚓︎
(result: QueryResult) => void
Sends individual results back to search clients.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| result⚓︎ | QueryResult | Individual search result to send back to search clients. |