GetTrendingSearchesViewOptions

class GetTrendingSearchesViewOptions


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

Summary

Public constructors

Public functions

GetTrendingSearchesViewOptions!

Specifies the client ID used to request the trending searches view.

GetTrendingSearchesViewOptions!

Specifies the maximum number of trends returned from the backend.

GetTrendingSearchesViewOptions!

Sets the view options which provides the options to customize the trending searches UI view.

Public constructors

GetTrendingSearchesViewOptions

GetTrendingSearchesViewOptions()

Public functions

setClientId

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

Specifies the client ID used to request the trending searches view.

Parameters
clientId: String!

the client ID to specify.

Returns
GetTrendingSearchesViewOptions!

the current GetTrendingSearchesViewOptions object.

setMaxNumTrends

@CanIgnoreReturnValue
fun setMaxNumTrends(maxNumTrends: Int): GetTrendingSearchesViewOptions!

Specifies the maximum number of trends returned from the backend.

Parameters
maxNumTrends: Int

the maximum number of returned trends.

Returns
GetTrendingSearchesViewOptions!

the current GetTrendingSearchesViewOptions object.

setTrendingSearchesViewOptions

@CanIgnoreReturnValue
fun setTrendingSearchesViewOptions(
    trendingSearchesViewOptions: SearchSuggestionsViewOptions!
): GetTrendingSearchesViewOptions!

Sets the view options which provides the options to customize the trending searches UI view.

Parameters
trendingSearchesViewOptions: SearchSuggestionsViewOptions!

the SearchSuggestionsViewOptions object used to customize the trending searches UI view.

Returns
GetTrendingSearchesViewOptions!

the current GetTrendingSearchesViewOptions object.