RSDStepViewController

The stepViewModel presented by the step view controller.

If you use a storyboard to initialize the step view controller, init(step:parent:) isn’t called, so you need to set the stepViewModel property directly before the step view controller is presented.

Setting the value of stepViewModel after the controller has been presented is an error that generates an assertion. Modifying the value of stepViewModel after the controller has been presented is an error that has undefined results.

Instantiate a step view model appropriate to this step.

Convenience property for accessing the step from the step view model.

Convenience property for casting the step to a RSDUIStep.

Convenience property for casting the step to a RSDDesignableUIStep.

Convenience property for casting the step to a RSDActiveUIStep.

Returns the current result associated with this step. This property uses a lazy initializer to instantiate the result and append it to the step history if not found in the step history.

Returns a new step view controller for the specified step.

Initialize the class using the given nib and bundle.

Required initializer. This is the initializer used by a UIStoryboard.

Track whether or not the view is visible. The value of this flag is set to true in viewDidAppear before anything else is done. It is set to false in viewWillDisappear before anything else is done.

Track whether or not this is the first appearance. This flag is set to true in viewDidAppear. This flag is used to mark whether or not to call performStartCommands().

Should this step play an alarm if the phone screen is locked and the app is running in the background? If this is true then an alert will run (sound and vibration) until the user opens their phone. The default is false.

This is intended for active tasks where the participant needs to look at their phone as soon as possible following a step that was running in the background to alert them to a follow-up action.

The design system to use with this step view controller.

Override viewWillAppear to set up the navigation, step details, and background color theme if this is the first appearance.

Override viewDidAppear to set the flag for isVisible, mark the result startDate, perform the start commands, and if the active commands include disabling the idle timer then do so in this method.

Override viewWillDisappear to set the isVisible flag and enable the idle timer if it was disabled in view will appear.

A mapping of all the buttons that were registered using setupButton.

A UIView that is behind the status bar. This can be used to set the background for only the top part of a step view.

A header view that includes navigation elements.

A footer view that includes navigation elements.

A view for the main body.

The label for displaying step title text.

The label for displaying step text.

The label for displaying step detail text.

Convenience method for getting the Next button.

Convenience method for getting the Learn More button.

Is forward navigation enabled? The default implementation will check the task controller.

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

Set up the navigation header and footer. Additionally, set up the UI theme colors, UI images, and the step details such as the title, text, detail, and progress.

Set up the background color using the colorTheme from the step. This method does nothing if the step does not conform to the RSDThemedUIStep protocol.

Returns the background color tile to use for the given placement. This should look to see if there is color mapping defined by the designable step, then looks to the default if that is undefined.

Returns the default background color tile to use for the given placement.

Set the color style for the given placement elements. This allows overriding by subclasses to customize the view style.

The status bar overlay is a view that is set up to be underneath the status bar.

• Default: If the background uses light style then the overlay is clear else RSDColor.black.withAlphaComponent(0.1) If there is a background image then the statusbar background is clear else background.color

Set up the header. Because this may be used in a table view as the table’s header view, this includes all the step details that are typically at the top of the view such as setting images, text, and progress. Additionally, this method will set up the navigation buttons included in the header view and any color themes that are appropriate.

Set up the footer. This method will set up the navigation buttons included in the footer view and any color themes that are appropriate.

Set up the navigation UI elements for the given view. By default, this method will check for whether or not a button should be hidden and set the visibility as is appropriate. For example, the first step in a task should never show a back button. This will also setup color themes, images, selectors, etc.

Return the image theme for this step view controller.

By default, this method will return true if the image theme uses a placement of topBackground or topMarginBackground.

Convenience method for setting up each of the buttons. This will set up color theme, add the selector, and hide the button if indicated by the UI and the task state.

Returns true if the given RSDColorPlacement and RSDImagePlacementType indicate that this view controller should set an image, false otherwise.

Momentarily disable the button. This keeps a double-tap of a navigation button from triggering more than once. This is required b/c of how the UI handles the call to go forward/backward by calling a method that just looks at the current step.

Navigates forward to the next step. By default, it calls performStopCommands() to end the step and speaks the end instruction. When the end instruction is done, it will call goForward on the task controller.

When a user taps a Next button, the information passes through this method. You can use this method as an override point or a target action for a subclass.

Navigates backward to the previous step. By default, it calls stop() to stop the timer and then calls goBack on the task controller.

When a user taps the Back button, the information passes through this method. You can use this method as an override point or a target action for a subclass.

This method is called when the user taps the skip button. This method will call actionTapped(with: .navigation(.skip)) to handle marking the result of the action (if required by the UI) and then will call jumpForward().

By default, this method calls stop() to stop the timer and then calls goForward on the task controller. It is used to handle navigating away from the current step view controller in a manner which requires custom navigation because the step has not ended normally. For example, this method is called when a user taps the skip button.

This method is called when the user taps the cancel button. By default, it confirms that the task should be canceled (unless this is the first step in the task). If the user confirms exit, then cancelTask is called.

Call through to the task view model.

Finish canceling the task. This is called once the cancel is confirmed by the user.

This method is called when the user taps the learn more button. The default implementation will check if the learn more action is an RSDResourceTransformer and if so, will assume that the learn more is an embedded HTML file or an online URL. It will instantiate RSDWebViewController and present it modally.

This method is called when the user taps the review instructions button. The default implementation will check if the review action is an RSDNavigationUIAction and if so, will navigate back to that instruction, setting a value in the async results, marking that abbreviated instructions should not be shown.

Perform any actions associated with a given action type. By default, this is called before any other standard actions on a standard navigation are handled.

Mutate the current result by appending the results with a skipToIdentifier.

Show an alert to the user to let them know that authorization has failed.

The authorization status for this view controller.

Check the authorization status for a given permission type.

The permissions required for this step.

The permissions that are requested as a part of this step.

The countdown is a second countdown used by active steps. This value will be 0 if not used. Otherwise, countdown = duration - timeIntervalSinceStart.

Should this step start the timer? By default, this will return true for active steps. However, if you are running your app in the background, then you will need to set up a secondary means of keeping the app from suspending when the user locks the screen. You can do so by playing music or by using background GPS location updates.

Time interval for firing a repeating timer. Default = 1.

The clock uptime for when the step was started. This is used by the timer to determine when to speak the next instruction and to set the value of the countdown.

The clock uptime for when the step was finished.

Perform any start commands. This will speak an instruction that is set up for the start of the step, set the initial countdown value, and handle any RSDActiveUIStepCommand related to start up including starting the timer if the step should start automatically.

Perform any stop command. This will also call stop() to stop the timer.

Play a sound. The default method will use the shared instance of RSDAudioSoundPlayer.

Vibrate the device (if applicable).

Speak the given instruction. The default method will use the shared RSDSpeechSynthesizer.

Speak the instruction that is included at the given time marker (if any).

Speak the end command (spoken instruction) and then call the completion once finished. If the end command was previously spoken, then this will call the completion immediately.

Returns the spoken instruction for a given time point. Default calls the active step spoken instruction.

Start the timer.

Stop the timer.

Pause the timer.

Resume the timer.

Method fired when the timer fires. This method will be called when the timer fires. Should you need to run in the background, you will need to use playing music or GPS updates to keep the app from going to sleep.

The method will first check to see if the step should be transitioned automatically, based on the uptime and the step duration.

If the step is completed (countdown == 0), it will transition to the next step.

If the timer fires and the step is still running, it will check to see if there is a vocal instruction to speak since the last firing of the timer.

If the app is running in the background, and running in the background is not allowed for this step, then the app will start calling playAlert() using dispatch_async with a delay. By default, that method will play an alarm sound and vibrate the device to alert the user to bring the app to the foreground in order to continue the task. Once the app is active, then it will start the step.