kotlin-components-docs/mozilla.appservices.remotesettings/RemoteSettingsContext

RemoteSettingsContext

data class RemoteSettingsContext(var appName: String, var appId: String, var channel: String, var appVersion: String?, var appBuild: String?, var architecture: String?, var deviceManufacturer: String?, var deviceModel: String?, var locale: String?, var os: String?, var osVersion: String?, var androidSdkVersion: String?, var debugTag: String?, var installationDate: Long?, var homeDirectory: String?, var customTargetingAttributes: <Error class: unknown class>?)

The RemoteSettingsContext object represents the parameters and characteristics of the consuming application. For remote-settings, it is used to filter locally stored records.

We always fetch all records from the remote-settings storage. Some records could have a filter_expression attached to them, which will be matched against the RemoteSettingsContext.

When set, only records where the expression is true will be returned.

Constructors

Link copied to clipboard
constructor(appName: String, appId: String, channel: String, appVersion: String?, appBuild: String?, architecture: String?, deviceManufacturer: String?, deviceModel: String?, locale: String?, os: String?, osVersion: String?, androidSdkVersion: String?, debugTag: String?, installationDate: Long?, homeDirectory: String?, customTargetingAttributes: <Error class: unknown class>?)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var androidSdkVersion: String?

Android specific for targeting specific sdk versions

Link copied to clipboard
var appBuild: String?

Build identifier generated by the CI system (e.g. "1234/A")

Link copied to clipboard
var appId: String

Application identifier, especially for mobile (e.g. "org.mozilla.fenix")

Link copied to clipboard
var appName: String

Name of the application (e.g. "Fenix" or "Firefox iOS")

Link copied to clipboard
var appVersion: String?

User visible version string (e.g. "1.0.3")

Link copied to clipboard
var architecture: String?

The architecture of the device, (e.g. "arm", "x86")

Link copied to clipboard
var channel: String

The delivery channel of the application (e.g "nightly")

Link copied to clipboard
var customTargetingAttributes: <Error class: unknown class>?

Contains attributes specific to the application, derived by the application

Link copied to clipboard
var debugTag: String?

Used for debug purposes as a way to match only developer builds, etc.

Link copied to clipboard
var deviceManufacturer: String?

The manufacturer of the device the application is running on

Link copied to clipboard
var deviceModel: String?

The model of the device the application is running on

Link copied to clipboard
var homeDirectory: String?

The application's home directory

Link copied to clipboard
var installationDate: Long?

The date the application installed the app

Link copied to clipboard
var locale: String?

The locale of the application during initialization (e.g. "es-ES")

Link copied to clipboard
var os: String?

The name of the operating system (e.g. "Android", "iOS", "Darwin", "Windows")

Link copied to clipboard
var osVersion: String?

The user-visible version of the operating system (e.g. "1.2.3")