kotlin-components-docs/mozilla.appservices.search/SearchUrlParam

SearchUrlParam

data class SearchUrlParam(var name: String, var value: String?, var enterpriseValue: String?, var experimentConfig: String?)

Parameter definitions for search engine URLs. The name property is always specified, along with one of value, experiment_config or search_access_point.

Constructors

SearchUrlParam

constructor(name: String, value: String?, enterpriseValue: String?, experimentConfig: String?)

Types

Companion

object Companion

Properties

enterpriseValue

var enterpriseValue: String?

Same as value but only used if Services.polices.isEnterprise is true. Overrides other parameters of the same name.

experimentConfig

var experimentConfig: String?

The value for the parameter will be derived from the equivalent experiment configuration value. Only desktop uses this currently.

name

var name: String

The name of the parameter in the url.

value

var value: String?

The parameter value, this may be a static value, or additionally contain a parameter replacement, e.g. {inputEncoding}. For the partner code parameter, this field should be {partnerCode}.