OfflineODataProviderDownloadProgress

public struct OfflineODataProviderDownloadProgress : OfflineODataProviderProgressReporting

Contains information about the progress of a download operation.

  • The GUID of the operation

    Declaration

    Swift

    public private(set) var operationId: String { get }

  • The current step number out of the total number of steps.

    Declaration

    Swift

    public private(set) var currentStepNumber: Int { get }

  • The total number of steps for the operation.

    Declaration

    Swift

    public private(set) var totalNumberOfSteps: Int { get }

  • The time of the last update to the progress.

    Declaration

    Swift

    public private(set) var time: GlobalDateTime { get }

  • The particular step being performed.

    Declaration

    Swift

    public private(set) var step: OfflineODataOperationStep { get }

  • The parameters for the particular step being performed. This will vary for each step.

    For OfflineODataOperationStep.downloadingEntityStore

     parameters[0]: received bytes
 parameters[1]: total bytes

    For OfflineODataOperationStep.processingDefiningQueries

     parameters[0]: request name
 parameters[1]: request url

    For OfflineODataOperationStep.processingRequests

     parameters[0]: request number
 parameters[1]: total number of requests

    For OfflineODataOperationStep.receivingDataFromServer

     parameters[0]: received bytes

    For OfflineODataOperationStep.sendingDataToServer

     parameters[0]: sent bytes

    For others steps

     parameters is an empty array

    Declaration

    Swift

    public private(set) var parameters: [String] { get }

  • A default message for the current step.

    Declaration

    Swift

    public private(set) var defaultMessage: String { get }

  • The OfflineODataProvider will queue up download operations where a different subset of the defining queries is specified. The subset property of OfflineODataProviderDownloadProgress contains the subset of defining queries specified for the download operation. If no subset was specified, the subset property will be nil.

    Declaration

    Swift

    public private(set) var subset: [OfflineODataDefiningQuery]? { get }