RSDPathComponent

public protocol RSDPathComponent : AnyObject

A path component holds state for navigating and displaying a task with a UX that is appropriate to a given platform.

  • A unique identifier for this path component.

    Declaration

    Swift

    var identifier: String { get }

  • The current child that this component is pointing to.

    Declaration

    Swift

    var currentChild: RSDNodePathComponent? { get }

  • The parent path component. If nil, this is the top-level path component.

    Declaration

    Swift

    var parent: RSDPathComponent? { get }

  • The task result associated with this path component.

    Declaration

    Swift

    var taskResult: RSDTaskResult { get set }

  • Can this task go forward? If forward navigation is enabled, then the task isn’t waiting for a result or a task fetch to enable forward navigation.

    Declaration

    Swift

    var isForwardEnabled: Bool { get }

  • Can the path navigate backward up the chain? This property should be set to true if and only if the backwards navigation is blocked by this path component or its child path component.

    Declaration

    Swift

    var canNavigateBackward: Bool { get }

  • File URL for the directory in which to store generated data files. Asynchronous actions with recorders (and potentially steps) can save data to files during the progress of the task. This property specifies where such data should be written.

    Declaration

    Swift

    var outputDirectory: URL! { get }

  • The result to use to mark the step history for this path component.

    Declaration

    Swift

    func pathResult() -> RSDResult

  • Go forward to the next step.

    Declaration

    Swift

    func perform(actionType: RSDUIActionType)
  • rootPathComponent Extension method

    Convenience method for accessing the top-level path component.

    Declaration

    Swift

    public var rootPathComponent: RSDTaskViewModel! { get }
  • currentNode Extension method

    Convenience method for accessing the lowest-level node. For a UI task, this will point to the step that is currently being displayed.

    Declaration

    Swift

    public var currentNode: RSDNodePathComponent? { get }
  • fullPath Extension method

    String identifying the full path for this task.

    Declaration

    Swift

    public var fullPath: String { get }
  • stepPath Extension method

    String representing the current order of steps to this point in the task.

    Declaration

    Swift

    public var stepPath: String { get }
  • isFirstStep Extension method

    Is this the first step in the task?

    Declaration

    Swift

    public var isFirstStep: Bool { get }