OperationProgress

open class OperationProgress : ObjectBase

Generalized operation progress information, e.g. for network download / upload operations.

  • A name (prefix) for the current operation phase. Examples: ENTITY_DOWNLOAD, STREAM_DOWNLOAD, REQUEST_UPLOAD.

    Declaration

    Swift

    final public var phaseName: String

  • A number (suffix) for the current operation phase.

    Declaration

    Swift

    final public var phaseNumber: Int

  • A name for the current operation step (within the current phase), or nil if unknown or inapplicable.

    Declaration

    Swift

    final public var currentStep: String?

  • Name of the last completed operation step (within the current phase), or nil if unknown or inapplicable.

    Declaration

    Swift

    final public var lastCompleted: String?

  • The number of completed steps in the current phase.

    Declaration

    Swift

    final public var completedSteps: Int

  • Total number of steps in the current phase.

    Declaration

    Swift

    final public var totalSteps: Int

  • Total number of creates processed in the current phase.

    Declaration

    Swift

    final public var totalCreates: Int64

  • Total number of updates processed in the current phase.

    Declaration

    Swift

    final public var totalUpdates: Int64

  • Total number of deletes processed in the current phase.

    Declaration

    Swift

    final public var totalDeletes: Int64

  • Either completedSteps / totalSteps, or some other measure that more reliably indicates, considering elapsed time, the fraction of steps which are already completed for the current phase (e.g. current bytes transferred divided by total bytes to be transferred). The value of this property should be in the range 0.0 to 1.0 (inclusive).

    Declaration

    Swift

    final public var fractionComplete: Double

  • Time remaining for the current phase if it can be reasonably estimated, otherwise nil.

    Declaration

    Swift

    final public var estimatedTimeRemaining: DayTimeDuration?

  • Default initializer.

    Declaration

    Swift

    override public init()

  • Declaration

    Swift

    open func copy() throws -> OperationProgress

    Return Value

    A copy of this progress object.

  • A string identifying the current operation phase, by combining the phaseName (prefix) and the phaseNumber (suffix), separated by “.”. If phaseNumber is zero, the suffix will be omitted.

    Declaration

    Swift

    open var operationPhase: String { get }

  • Declaration

    Swift

    override open func toString() -> String

    Return Value

    A string representation of this object.