Creates an AutocompleteSettings object for you, based on AutocompleteSettings defaults and the overrides provided as a param.
The settings defined here will override the default AutocompleteSettings.
You can use this path to override the path to the rest-service. If not set, it will default to "RestService/v4".
The baseUrl for the rest-service.
A notifier method to call whenever the lookup fails. It is recommended to issue a clear and visible error to the user when this method is called, as there will be no results.
The callback exists for all services (Authentication, Autocomplete, Find and Categorize), but the severity of an error is very different for each of them:
Authentication (severity = 3): This should not happen if authentication is not enabled. If it is and this fails, then the user should be notified about the issue, as this might reduce the number of results they see (if any at all).
Autocomplete (severity = 1): Getting an error during autocomplete is not something that you want to inform the user about. A small warning in the console log would probably be perfect.
Find (severity = 3): Getting an error for this call is something that the user should be made aware of. You don't have to tell all the details, but you should make it clear to the user that the reason they have no matches is that an error occurred. Otherwise they might start speculating in why there are no results on screen, and in worst case scenario they might think that the query yielded 0 matches, which is potentially and probably not the truth.
Categorize (severity = 2): Errors while querying for categories are considered important, but less important than the Find errors. The reason is that the categories themselves are normally not the end-results that the user is waiting for. They are "meta" to the actual matches, and they are also a tool to help the user narrow down on the results, helping them find the data they are looking for.
A notifier method that is called just before the fetch operation is started. When the request is finished either cbSuccess or cbError will be called to indicate success or failure. This callback is typically used for setting loading indicators and/or debugging purposes.
Note: If the callback returns false then the fetch operation is skipped. This can then be used to conditionally drop requests from being made.
A notifier method to call whenever significant parts of the query has changed, and due to trigger settings, new results has yet not been requested. When called the UI could/should indicate that the results are invalid. This can be removing the results, showing them "greyed out", etc. The state is valid until the next cbRequest, Success or cbError is called.
A notifier method that is called whenever the lookup results have been received.
A notifier method to call when the lookup succeeds, but the received data from the backend indicates a problem. Note that although this callback can be defined in the settings for all services (Authentication, Autocomplete, Find and Categorize), only Find and Categorize uses it.
It is recommended to show these messages as complementary information to the user. Data was received and most likely the user can see results on their screen. There might however be scenarios were the data could somehow be i.e. incomplete.
For instance: Consider a situation where the backend search is scaled and uses multiple nodes without replicas. If some of the nodes respond, while one or more doesn't then the results are partial. This will be notified using this method. For that scenario, an explanation at a strategic location in the UI would help the user understand that the results may not be complete. Depending on the search query used, the results could be complete, as the node(s) that didn't respond might not have any matching results anyway. Hence - the user should be warned that the data may be incomplete.
Whether or not this setting-feature is enabled or not.
Defines the enum bit-field flags that signifies which query-fields that may resolve in changed results (both Categorize and Find).
The service-specific path added to the base-path.
The trigger-settings for when automatic suggestion updates are to be triggered.
Returns the actual url for the service.
Returns the actual url for the service.
Generated using TypeDoc
These are all the settings that can affect the returned suggestions for autocomplete() lookups.