GetSearchSuggestionsViewOptions

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

Public functions

GetSearchSuggestionsViewOptions!

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

GetSearchSuggestionsViewOptions!

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

GetSearchSuggestionsViewOptions!

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

GetSearchSuggestionsViewOptions!

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

Public constructors

GetSearchSuggestionsViewOptions

GetSearchSuggestionsViewOptions()

Public functions

setClientId

@CanIgnoreReturnValue
fun setClientId(clientId: String!): GetSearchSuggestionsViewOptions!

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

Parameters
clientId: String!

the client ID to specify.

Returns
GetSearchSuggestionsViewOptions!

the current GetSearchSuggestionsViewOptions object.

setLocationContext

@CanIgnoreReturnValue
fun setLocationContext(locationContext: (Mutable)List<LocationContext!>!): GetSearchSuggestionsViewOptions!

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

Parameters
locationContext: (Mutable)List<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
fun setSearchSuggestionsViewOptions(
    searchSuggestionsViewOptions: SearchSuggestionsViewOptions!
): GetSearchSuggestionsViewOptions!

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
fun setTextContext(textContext: (Mutable)List<String!>!): GetSearchSuggestionsViewOptions!

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

Parameters
textContext: (Mutable)List<String!>!

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.