Class AutocompleteResult
- java.lang.Object
-
- com.atlassian.confluence.api.model.search.autocomplete.AutocompleteResult
-
public class AutocompleteResult extends Object
Represents a set of results from an autocomplete Search request.Returned results can be "suggested" (promoted to the user) or "search" (anything found that isn't promoted). There should be no items duplicated between the two result lists, and either list may be empty.
- Since:
- 5.9
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AutocompleteResult.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AutocompleteResult.Builder
builder()
List<AutocompleteResultItem>
getSearchResults()
Search results are intended to be shown to the user below those returned bygetSuggestedResults()
.List<AutocompleteResultItem>
getSuggestedResults()
Suggested results are intended to be shown to the user above those returned bygetSearchResults()
, and may be returned with or without search results.
-
-
-
Method Detail
-
builder
public static AutocompleteResult.Builder builder()
-
getSuggestedResults
public List<AutocompleteResultItem> getSuggestedResults()
Suggested results are intended to be shown to the user above those returned bygetSearchResults()
, and may be returned with or without search results.An example of when only suggested results could be returned is when there is a blank query.
-
getSearchResults
public List<AutocompleteResultItem> getSearchResults()
Search results are intended to be shown to the user below those returned bygetSuggestedResults()
.
-
-