RSDUIStepObject

A short string that uniquely identifies the step within the task. The identifier is reproduced in the results of a step history.

The type of the step. This is used to decode the step using a RSDFactory. It can also be used to customize the UI.

The primary text to display for the step in a localized string.

Additional text to display for the step in a localized string.

The additional text is often displayed in a smaller font below title. If you need to display a long question, it can work well to keep the title short and put the additional content in the text property.

Additional detailed explanation for the step.

The font size and display of this property will depend upon the device type.

Additional text to display for the step in a localized string at the bottom of the view.

The footnote is intended to be displayed in a smaller font at the bottom of the screen. It is intended to be used in order to include disclaimer, copyright, etc. that is important to display in the step but should not distract from the main purpose of the step.

The permissions used by this task that are described by this step.

Should this step be displayed if and only if the flag has been set for displaying the full instructions?

The view info used to create a custom step.

The color theme.

The image theme.

The next step to jump to. This is used where direct navigation is required. For example, to allow the task to display information or a question on an alternate path and then exit the task. In that case, the main branch of navigation will need to jump over the alternate path step and the alternate path step will need to jump to the exit.

This step is not intended for optional navigation where the result might change the intended navigation. For the case where a user action might result in a different navigation path, you can have the step controller set the step result to a result that implements RSDNavigationResult and then set the skipToIdentifier on that result. RSDResultObject and RSDCollectionResultObject both implement this protocol. The reason for doing this is that each time a step is visited in a a navigation path, the result of that step is replaced with an immutable result and will not use the previous result navigation unless specifically set by the step controller.

The navigation cohort rules to apply before displaying the step.

The navigation cohort rules to apply after displaying the step.

The default step type.

Default initializer.

Initializer for setting the immutable next step identifier.

Copy the step to a new instance with the given identifier, but otherwise, equal.

Copy the step to a new instance with the given identifier and user info.

Swift subclass override for copying properties from the instantiated class of the copy(with:) method. Swift does not nicely handle casting from Self to a class instance for non-final classes. This is a work-around.

Instantiate a step result that is appropriate for this step. Default implementation will return a RSDResultObject.

Required method. The base class implementation does nothing.

Identifier for the next step to navigate to based on the current task result. By default, if there is a navigation skipToIdentifier for this step, then that will be honored. Otherwise, this will return nextStepIdentifier.

Initialize from a Decoder.

    // Example JSON for a step with an `RSDAnimatedImageThemeElement`.
    let json = """
       {
           "identifier": "foo",
           "type": "instruction",
           "title": "Hello World!",
           "text": "Some text.",
           "detail": "This is a test.",
           "footnote": "This is a footnote.",
           "nextStepIdentifier": "boo",
           "actions": { "goForward": { "type": "default", "buttonTitle" : "Go, Dogs! Go!" },
                        "cancel": { "type": "default", "iconName" : "closeX" }
                       },
           "shouldHideActions": ["goBackward"],
           "image"  : {    "type" : "animated",
                           "imageNames" : ["foo1", "foo2", "foo3", "foo4"],
                           "placementType" : "topBackground",
                           "animationDuration" : 2,
                              },
           "viewTheme"      : { "viewIdentifier": "ActiveInstruction",
                                "storyboardIdentifier": "ActiveTaskSteps",
                                "bundleIdentifier": "org.example.SharedResources" },
           "beforeCohortRules" : { "requiredCohorts" : ["boo", "goo"],
                                   "skipToIdentifier" : "blueGu",
                                   "operator" : "any" },
           "afterCohortRules" : { "requiredCohorts" : ["boo", "goo"],
                                   "skipToIdentifier" : "blueGu",
                                   "operator" : "any" }
       }
       """.data(using: .utf8)! // our data in native (JSON) format

    // Example JSON for a step with an `RSDFetchableImageThemeElement`.
    let json = """
       {
           "identifier"   : "goOutside",
           "type"         : "instruction",
           "title"        : "Go outside",
           "image"        : {   "type" : "fetchable",
                                "imageName": "goOutsideIcon",
                                "placementType": "topBackground" },
           "colorMapping"   : { "customColor": {"backgroundColor" : "robinsEggBlue", "usesLightStyle" : true }},
           "actions"      : { "goForward": { "type": "default", "buttonTitle": "I am outside" }},
       }
       """.data(using: .utf8)! // our data in native (JSON) format

Decode from the given decoder, replacing values on self with those from the decoder if the properties are mutable.

Decode from the given decoder, replacing values on self with those from the decoder if the properties are mutable. This function is designed to loop through a second pass to replace any values that should be decoded for a specific device type.