SyncOptions

open class SyncOptions : ObjectBase, @unchecked Sendable

Request options for OfflineDataService.download and OfflineDataService.upload.

  • Immutable value for “no” upload options.

    Declaration

    Swift

    public static let none: SyncOptions

  • Default initializer.

    Declaration

    Swift

    override public init()

  • Set this to a cancellation token before initiating an async request if request cancellation may be needed.

    Declaration

    Swift

    open var cancelToken: CancelToken? { get set }

  • Set the cancelToken and return this options object.

    Declaration

    Swift

    open func cancelable(_ token: CancelToken) -> SyncOptions

    Parameters

    token

    Cancellation token.

    Return Value

    This options object.

  • Declaration

    Swift

    open func copy() -> SyncOptions

    Return Value

    a new (mutable) request options object that is a copy of this request options object.

  • Set the progressListener and return this options object.

    Declaration

    Swift

    open func listen(_ listener: ProgressListener) -> SyncOptions

    Parameters

    listener

    Progress listener.

    Return Value

    This options object.

  • Set this to a progress listener to receive notifications of upload/download progress.

    Declaration

    Swift

    open var progressListener: ProgressListener? { get set }