kotlin-components-docs/mozilla.appservices.merino/SuggestOptions

SuggestOptions

data class SuggestOptions(var providers: List<String>?, var source: String?, var country: String?, var region: String?, var city: String?, var clientVariants: List<String>?, var requestType: String?, var acceptLanguage: String?)

Options for a suggest request, mapped to merino suggest endpoint query parameters. All fields are optional — omitted fields are not sent to merino.

Constructors

SuggestOptions

constructor(providers: List<String>?, source: String?, country: String?, region: String?, city: String?, clientVariants: List<String>?, requestType: String?, acceptLanguage: String?)

Types

Companion

object Companion

Properties

acceptLanguage

var acceptLanguage: String?

The Accept-Language header value to forward to Merino (e.g. "en-US").

city

var city: String?

City name (e.g. "San Francisco").

clientVariants

var clientVariants: List<String>?

List of any experiments or rollouts that are affecting the client's Suggest experience. If Merino recognizes any of them it will modify its behavior accordingly.

country

var country: String?

ISO 3166-1 country code (e.g. "US").

providers

var providers: List<String>?

List of suggestion providers to query (e.g. ["wikipedia", "adm"]).

region

var region: String?

Comma separated string of subdivision code(s) (e.g. "CA").

requestType

var requestType: String?

For AccuWeather provider, the request type should be either a "location" or "weather" string. For "location" it will get location completion suggestion. For "weather" it will return weather suggestions. If omitted, it defaults to weather suggestions.

source

var source: String?

Identifier of which part of firefox the request comes from (e.g. "urlbar", "newtab").