SyncParams

public struct SyncParams
extension SyncParams: Equatable, Hashable
  • Why are we performing this sync?

    Declaration

    Swift

    public var reason: SyncReason
  • Which engines should we sync?

    Declaration

    Swift

    public var engines: SyncEngineSelection
  • 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).

    Declaration

    Swift

    public var enabledChanges: [String : Bool]
  • 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.

    Declaration

    Swift

    public var localEncryptionKeys: [String : String]
  • Authorization for the sync server

    Declaration

    Swift

    public var authInfo: SyncAuthInfo
  • 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”.

    Declaration

    Swift

    public var persistedState: String?
  • Information about the current device, such as its name, formfactor and FxA device ID.

    Declaration

    Swift

    public var deviceSettings: DeviceSettings
  • Declaration

    Swift

    public init(
        /**
         * Why are we performing this sync?
         */reason: SyncReason, 
        /**
         * Which engines should we sync?
         */engines: SyncEngineSelection, 
        /**
         * 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).
         */enabledChanges: [String: Bool], 
        /**
         * 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.
         */localEncryptionKeys: [String: String], 
        /**
         * Authorization for the sync server
         */authInfo: SyncAuthInfo, 
        /**
         * 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".
         */persistedState: String?, 
        /**
         * Information about the current device, such as its name, formfactor and
         * FxA device ID.
         */deviceSettings: DeviceSettings)
  • Declaration

    Swift

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

    Swift

    public func hash(into hasher: inout Hasher)