RSDStepViewPathComponent

public protocol RSDStepViewPathComponent : RSDNodePathComponent

A step view path component is used to present a step.

  • Method for getting the progress through the task for the current step with the current result.

    Declaration

    Swift

    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).

  • An identifier string that can be appended to a step view controller to differentiate this step from another instance in a different section.

    Declaration

    Swift

    func sectionIdentifier() -> String

  • Convenience method for accessing the step result associated with this step.

    Declaration

    Swift

    func findStepResult() -> RSDResult?

  • Get the action for the given action type.

    Declaration

    Swift

    func action(for actionType: RSDUIActionType) -> RSDUIAction?

    Parameters

    actionType

    The action type to get.

    Return Value

    The action if found.

  • Should the action be hidden for the given action type?

    Declaration

    Swift

    func shouldHideAction(for actionType: RSDUIActionType) -> Bool

    Parameters

    actionType

    The action type to get.

    Return Value

    true if the action should be hidden.

  • parentTaskPath Extension method

    Convenience method for accessing the task path component that presented this step view. This method uses recursion to look up the path chain until it finds a path component that implements the RSDTaskPathComponent protocol.

    Declaration

    Swift

    public var parentTaskPath: RSDTaskPathComponent? { get }