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

SyncResult

data class SyncResult(var status: ServiceStatus, var successful: List<String>, var failures: Map<String, String>, var persistedState: String, var declined: List<String>?, var nextSyncAllowedAt: Instant?, var telemetryJson: String?)

Constructors

Link copied to clipboard
constructor(status: ServiceStatus, successful: List<String>, failures: Map<String, String>, persistedState: String, declined: List<String>?, nextSyncAllowedAt: Instant?, telemetryJson: String?)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var declined: List<String>?

The list of engines which are marked as "declined" (ie, disabled) on the sync server. The list of declined engines is global to the account rather than to the device. Apps should use this after every sync to update the local state (ie, to ensure that their Sync UI correctly reflects what engines are enabled and disabled), because these could change after every sync.

Link copied to clipboard
var failures: Map<String, String>

Maps the names of engines that failed to sync to the reason why

Link copied to clipboard
var nextSyncAllowedAt: Instant?

Earliest time that the next sync should happen at

Link copied to clipboard
var persistedState: String

State that should be persisted to disk and supplied to the sync method on the next sync (See SyncParams.persisted_state).

Link copied to clipboard
var status: ServiceStatus

Result from the sync server

Link copied to clipboard
var successful: List<String>

Engines that synced successfully

Link copied to clipboard
var telemetryJson: String?

JSON string encoding a SyncTelemetryPing object