SyncResult

public struct SyncResult
extension SyncResult: Equatable, Hashable
  • Result from the sync server

    Declaration

    Swift

    public var status: ServiceStatus
  • Engines that synced successfully

    Declaration

    Swift

    public var successful: [String]
  • Maps the names of engines that failed to sync to the reason why

    Declaration

    Swift

    public var failures: [String : String]
  • State that should be persisted to disk and supplied to the sync method on the next sync (See SyncParams.persisted_state).

    Declaration

    Swift

    public var persistedState: 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.

    Declaration

    Swift

    public var declined: [String]?
  • Earliest time that the next sync should happen at

    Declaration

    Swift

    public var nextSyncAllowedAt: Date?
  • JSON string encoding a SyncTelemetryPing object

    Declaration

    Swift

    public var telemetryJson: String?
  • Declaration

    Swift

    public init(
        /**
         * Result from the sync server
         */status: ServiceStatus, 
        /**
         * Engines that synced successfully
         */successful: [String], 
        /**
         * Maps the names of engines that failed to sync to the reason why
         */failures: [String: String], 
        /**
         * State that should be persisted to disk and supplied to the sync method
         * on the next sync (See SyncParams.persisted_state).
         */persistedState: 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.
         */declined: [String]?, 
        /**
         * Earliest time that the next sync should happen at
         */nextSyncAllowedAt: Date?, 
        /**
         * JSON string encoding a `SyncTelemetryPing` object
         */telemetryJson: String?)
  • Declaration

    Swift

    public static func == (lhs: SyncResult, rhs: SyncResult) -> Bool
  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)