Providerinterface
Describes a registered search provider.
Properties (5)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| appName⚓︎ | string | x | x | Name of the app that has registered the search provider. |
| id⚓︎ | string | x | Unique app ID within the framework. |
|
| interopId⚓︎ | string | x | Unique ID of the Interop instance of the app. |
|
| name⚓︎ | string | x | Name of the search provider. |
|
| types⚓︎ | SearchType[] | x | x | List of search types with which the search provider works. |
3 Methods
onQuery()⚓︎
(callback: (query: ProviderQuery) => void) => UnsubscribeFunction
Notifies when a search query is received.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | (query: ProviderQuery) => void | Callback function for handling the event. Receives as an argument an object describing the search query. |
onQueryCancel()⚓︎
(callback: (query: { id: string }) => void) => UnsubscribeFunction
Notifies when a search query is canceled.
Parameters (1)
| Name | Type | Required | Description |
|---|---|---|---|
| callback⚓︎ | (query: { id: string }) => void | Callback function for handling the event. Receives as an argument an object with an |