GetSearchSuggestionsViewOptions

Kotlin |Java

public final class GetSearchSuggestionsViewOptions

---

This class contains all the options necessary to request search suggestions UI view. Callers need to obtain a valid client ID before for response to be returned.

Summary

Public constructors
GetSearchSuggestionsViewOptions()

Public methods
GetSearchSuggestionsViewOptions	@CanIgnoreReturnValue setClientId(String clientId) Specifies the client ID used to request the search suggestions view.
GetSearchSuggestionsViewOptions	@CanIgnoreReturnValue setLocationContext(List<LocationContext> locationContext) Specifies the location context of this request so that the returned suggestions will be related to a given list of location contexts.
GetSearchSuggestionsViewOptions	@CanIgnoreReturnValue setSearchSuggestionsViewOptions(     SearchSuggestionsViewOptions searchSuggestionsViewOptions ) Sets the view options which provides the options to customize the search suggestions UI view.
GetSearchSuggestionsViewOptions	@CanIgnoreReturnValue setTextContext(List<String> textContext) Specifies the text context of this request so that the returned suggestions will be related to a given list of texts.

Public constructors

GetSearchSuggestionsViewOptions

public GetSearchSuggestionsViewOptions()

Public methods

setClientId

@CanIgnoreReturnValue
public GetSearchSuggestionsViewOptions setClientId(String clientId)

Specifies the client ID used to request the search suggestions view.

Parameters
String clientId	the client ID to specify.

Returns
GetSearchSuggestionsViewOptions	the current GetSearchSuggestionsViewOptions object.

setLocationContext

@CanIgnoreReturnValue
public GetSearchSuggestionsViewOptions setLocationContext(List<LocationContext> locationContext)

Specifies the location context of this request so that the returned suggestions will be related to a given list of location contexts.

Parameters
List<LocationContext> locationContext	a list of location contexts to help generate search suggestions. Currently only the first element in this list will be used.

Returns
GetSearchSuggestionsViewOptions	the current GetSearchSuggestionsViewOptions object.

setSearchSuggestionsViewOptions

@CanIgnoreReturnValue
public GetSearchSuggestionsViewOptions setSearchSuggestionsViewOptions(
    SearchSuggestionsViewOptions searchSuggestionsViewOptions
)

Sets the view options which provides the options to customize the search suggestions UI view.

Parameters
SearchSuggestionsViewOptions searchSuggestionsViewOptions	the SearchSuggestionsViewOptions object used to customize the search suggestions UI view.

Returns
GetSearchSuggestionsViewOptions	the current GetSearchSuggestionsViewOptions object.

setTextContext

@CanIgnoreReturnValue
public GetSearchSuggestionsViewOptions setTextContext(List<String> textContext)

Specifies the text context of this request so that the returned suggestions will be related to a given list of texts.

Parameters
List<String> textContext	a list of texts to help generate search suggestions. Currently only the first element in this list will be used.

Returns
GetSearchSuggestionsViewOptions	the current GetSearchSuggestionsViewOptions object.