Suggestion
Represents query suggestion.
This table describes attributes of the Suggestion
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
completionStart | Int | Start index of inserted string. |
completionEnd | Int | End index of inserted string. |
matchingStart | Int | Start index of the matched string. |
matchingEnd | Int | End index of the matched string. |
caret | Int | Position of the caret after insertion. |
description | String | Description of the suggested item. |
option | String | Suggested option. |
prefix | String | Prefix that should be inserted before the option. |
suffix | String | Suffix that should be inserted after the option. |
group | String | Name of the group for the suggestion. |
icon | String | An icon URI for the item. |
auxiliaryIcon | String | An additional icon URI for the item. |
className | String | Css class name that should be used for the item. |