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

SearchUserEnvironment

data class SearchUserEnvironment( var locale: String, var region: String, var updateChannel: SearchUpdateChannel, var distributionId: String, var experiment: String, var appName: SearchApplicationName, var version: String, var deviceType: SearchDeviceType)

The user's environment that is used for filtering the search configuration.

Constructors

constructor(locale: String, region: String, updateChannel: SearchUpdateChannel, distributionId: String, experiment: String, appName: SearchApplicationName, version: String, deviceType: SearchDeviceType)

Types

Companion

object Companion

Properties

appName

var appName: SearchApplicationName

The application name that the user is using.

deviceType

var deviceType: SearchDeviceType

The device type that the user is using.

distributionId

var distributionId: String

The distribution id for the user's build.

experiment

var experiment: String

The search related experiment id that the user is included within. On desktop this is the searchConfiguration.experiment variable.

locale

var locale: String

The current locale of the application that the user is using.

region

var region: String

The home region that the user is currently identified as being within. On desktop & android there is a 14 day lag after detecting a region change before the home region changes. TBD: iOS?

updateChannel

var updateChannel: SearchUpdateChannel

The update channel of the user's build.

version

var version: String

The application version that the user is using.