RSDTaskPathComponent

public protocol RSDTaskPathComponent : RSDHistoryPathComponent

A task path component is a navigational path component that, depending upon the UI/UX, may not have an associated view controller.

  • A pointer to the task controller that is running the task.

    Declaration

    Swift

    var taskController: RSDTaskController? { get }

  • The design system to use with this task path.

    Declaration

    Swift

    var designSystem: RSDDesignSystem { get }

  • The task that is currently being run. This can be nil if the task has not yet been loaded.

    Declaration

    Swift

    var task: RSDTask? { get }

  • Is there a next step or is this the last step in the task?

    While the default action for the forward navigation of the task is determined by the step navigator, there are cases where the step view model or task view model that is presenting the task will override the default navigation in response to a user action or failure such as failing to receive permissions required to perform the task.

    Declaration

    Swift

    var hasStepAfter: Bool { get }

  • Is there previous step that this task can go back to?

    Declaration

    Swift

    var hasStepBefore: Bool { get }

  • Move back up the path to the current step that has an associated view controller.

    Declaration

    Swift

    func moveBackToCurrentStep(from previousStep: RSDStep)

  • Move back from this path subtask to the previous step on the parent.

    Declaration

    Swift

    func moveBackToPreviousStep()

  • Move forward from this path subtask to the next step on the parent.

    Declaration

    Swift

    func moveForwardToNextStep()

  • Move to the first step in this task path in the given direction.

    Declaration

    Swift

    func moveToFirstStep(from direction: RSDStepDirection)
  • currentTaskPath Extension method

    Convenience method for accessing the lowest-level task path. This method uses recursion to look down the path chain for the lowest task path.

    Declaration

    Swift

    public var currentTaskPath: RSDTaskPathComponent { get }