kotlin-components-docs/mozilla.appservices.syncmanager/SyncParams

SyncParams

data class SyncParams(var reason: SyncReason, var engines: SyncEngineSelection, var enabledChanges: Map<String, Boolean>, var localEncryptionKeys: Map<String, String>, var authInfo: SyncAuthInfo, var persistedState: String?, var deviceSettings: DeviceSettings)

Constructors

SyncParams

constructor(reason: SyncReason, engines: SyncEngineSelection, enabledChanges: Map<String, Boolean>, localEncryptionKeys: Map<String, String>, authInfo: SyncAuthInfo, persistedState: String?, deviceSettings: DeviceSettings)

Types

Companion

object Companion

Properties

authInfo

var authInfo: SyncAuthInfo

Authorization for the sync server

deviceSettings

var deviceSettings: DeviceSettings

Information about the current device, such as its name, formfactor and FxA device ID.

enabledChanges

var enabledChanges: Map<String, Boolean>

Which engines should be enabled in the "account global" list (for example, if the UI was used to change an engine's state since the last sync).

engines

var engines: SyncEngineSelection

Which engines should we sync?

localEncryptionKeys

var localEncryptionKeys: Map<String, String>

Keys to encrypt/decrypt data from local database files. These are separate from the key we use to encrypt the sync payload as a whole.

persistedState

var persistedState: String?

An opaque string, as returned in the previous sync's SyncResult and persisted to disk, or null if no such state is available. This includes information such as the list of engines previously enabled, certain server timestamps and GUIDs etc. If this value isn't correctly persisted and round-tripped, each sync may look like a "first sync".

reason

var reason: SyncReason

Why are we performing this sync?