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

RemoteSettings

open class RemoteSettings : Disposable, AutoCloseable, RemoteSettingsInterface

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 collectionName: String, var bucketName: String? = null, var serverUrl: String? = null, var server: RemoteSettingsServer? = null)

Custom configuration for the client. Currently includes the following:

RemoteSettingsConfig2

data class RemoteSettingsConfig2(var server: RemoteSettingsServer? = null, var bucketName: String? = null)

Remote settings configuration

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.

RemoteSettingsException

sealed class RemoteSettingsException : Exception

Public error class, this is what we return to consumers

RemoteSettingsInterface

interface RemoteSettingsInterface

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.

RemoteSettingsResponse

data class RemoteSettingsResponse(var records: List<RemoteSettingsRecord>, var lastModified: ULong)

Data structure representing the top-level response from the Remote Settings. last_modified will be extracted from the etag header of the response.

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.

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.