kotlin-components-docs/mozilla.appservices.remotesettings

Package-level declarations

Types

data class Attachment(var filename: String, var mimetype: String, var location: String, var hash: String, var size: ULong)

Attachment metadata that can be optionally attached to a Record. The location should included in calls to Client::get_attachment.

Disposable

interface Disposable

InternalException

class InternalException(message: String) : Exception

RemoteSettingsClient

open class RemoteSettingsClient : Disposable, AutoCloseable, RemoteSettingsClientInterface

Client for a single Remote Settings collection

RemoteSettingsClientInterface

interface RemoteSettingsClientInterface

Client for a single Remote Settings collection

RemoteSettingsConfig

data class RemoteSettingsConfig(var server: RemoteSettingsServer? = null, var bucketName: String? = null, var appContext: RemoteSettingsContext? = null)

Remote settings configuration

RemoteSettingsContext

data class RemoteSettingsContext(var channel: String? = null, var appVersion: String? = null, var appId: String? = null, var locale: String? = null, var os: String? = null, var osVersion: String? = null, var formFactor: String? = null, var country: String? = null, var customTargettingAttributes: Map<String, String>? = null)

Remote settings context object

RemoteSettingsException

sealed class RemoteSettingsException : Exception

Public error class, this is what we return to consumers

RemoteSettingsRecord

data class RemoteSettingsRecord(var id: String, var lastModified: ULong, var deleted: Boolean, var attachment: Attachment?, var fields: <Error class: unknown class>)

A parsed Remote Settings record. Records can contain arbitrary fields, so clients are required to further extract expected values from the fields member.

RemoteSettingsServer

sealed class RemoteSettingsServer

The Remote Settings server that the client should use.

RemoteSettingsService

open class RemoteSettingsService : Disposable, AutoCloseable, RemoteSettingsServiceInterface

Application-level Remote Settings manager.

RemoteSettingsServiceInterface

interface RemoteSettingsServiceInterface

Application-level Remote Settings manager.

RemoteSettingsTelemetry

interface RemoteSettingsTelemetry

Trait implemented by consumers to record Remote Settings metrics with Glean.

RemoteSettingsTelemetryImpl

open class RemoteSettingsTelemetryImpl : Disposable, AutoCloseable, RemoteSettingsTelemetry

Trait implemented by consumers to record Remote Settings metrics with Glean.

RsJsonObject

typealias RsJsonObject = <Error class: unknown class>

Typealias from the type name used in the UDL file to the custom type. This is needed because the UDL type name is used in function/method signatures. It's also what we have an external type that references a custom type.

SyncStatus

enum SyncStatus : Enum<SyncStatus>

Remote Settings sync status.

UptakeEventExtras

data class UptakeEventExtras(var value: String?, var source: String?, var age: String?, var trigger: String?, var timestamp: String?, var duration: String?, var errorName: String?)