RSDStepController

public protocol RSDStepController : class, NSObjectProtocol

RSDStepController handles default implementations for running a step in a task.

  • Pointer back to the task controller that is displaying the step controller. The implementation of the task controller should set this pointer before displaying the step controller.

    Declaration

    Swift

    weak var taskController: RSDTaskController!

  • A pointer to the step with the model information used to display and run the step. The implementation of the task controller should set this pointer before displaying the step controller.

    Declaration

    Swift

    var step: RSDStep!

  • Callback from the task controller called on the current step controller when loading is finished and the task is ready to continue.

    Declaration

    Swift

    func didFinishLoading()

  • Is forward navigation enabled? This property allows the step controller to indicate that forward step is not enabled.

    Declaration

    Swift

    var isForwardEnabled: Bool

  • Navigate forward.

    Declaration

    Swift

    func goForward()

  • Navigate back.

    Declaration

    Swift

    func goBack()

  • Navigate forward by skipping the step.

    Declaration

    Swift

    func skipForward()

  • Cancel the task.

    Declaration

    Swift

    func cancel()
  • progress() Extension method

    Conveniece method for getting the progress through the task for the current step with the current result.

    Declaration

    Swift

    public func progress() -> (current: Int, total: Int, isEstimated: Bool)?

    Return Value

    • current: The current progress. This indicates progress within the task.
    • total: The total number of steps.
    • isEstimated: Whether or not the progress is an estimate (if the task has variable navigation)