ORKSpatialSpanMemoryStepViewController Class Reference

Inherits from ORKActiveStepViewController : ORKStepViewController : UIViewController
Declared in ORKSpatialSpanMemoryStepViewController.h
ORKSpatialSpanMemoryStepViewController.m

Overview

View controller corresponding to ORKSpatialSpanMemoryStep.

– initWithStep:

Returns a new step view controller for the specified step.

- (instancetype)initWithStep:(ORKStep *)step

Parameters

step

The step to be presented.

Return Value

A newly initialized step view controller.

Declared In

ORKStepViewController.h

– start

Starts the active step.

- (void)start

Discussion

Call this method to start the timer on the active step, if there is one, and to start any data recording.

When you start the step, recorders are instantiated based on their configurations and then started. All timers should start, and the UI should show users that the step is in progress.

This method does nothing if the step has already started.

Subclasses should super when overriding this method.

Declared In

ORKActiveStepViewController.h

– suspend

Suspends the active step.

- (void)suspend

Discussion

Call this method to suspend data recording and the step’s timer.

This method may called automatically when the app is suspended. The view controller can be configured not to suspend even if the app goes into the background (for more information, see suspendIfInactive).

Subclasses should call super when overriding this method.

Declared In

ORKActiveStepViewController.h

– resume

Resumes the active step.

- (void)resume

Discussion

Call this method when the step should be resumed. Calls to this method should be paired with previous calls to suspend.

This method may be called automatically when the app is resumed. The view controller can be configured not to suspend even if the app goes into the background (for more information, see suspendIfInactive).

When the step is resumed, the UI should resume at the point where the user left off, or, if that does not make sense for the particular step, to the most recent suitable point.

Subclasses should call super when overriding this method.

Declared In

ORKActiveStepViewController.h

– finish

Finishes the active step.

- (void)finish

Discussion

Call this method to finish the active step. If the active step is configured with a timer, this method is called automatically when the timer expires.

Finishing the active step stops all data recording and stops any timers. In steps that have the shouldContinueOnFinish property set, forward navigation to the next step may ensue.

This method does nothing if the step has already finished.

Subclasses should call super when overriding this method.

Declared In

ORKActiveStepViewController.h

– result

The current state of the result. (read-only)

- (ORKStepResult *)result

Discussion

The task view controller uses this property to get the results for the step, and to collate them into the task result.

The current step result and any subsidiary results representing data collected so far are available in this property. You can detect significant changes to the result, such as when the user enters a new answer, using the stepViewControllerResultDidChange: delegate callback.

Subclasses must use this property to return the current results. Subclasses may call super to obtain a clean, empty result object appropriate for the step, to which they can attach appropriate child results.

The implementations of this method in the ResearchKit framework currently create a new result object on every call, so do not call this method unless it is actually necessary.

Declared In

ORKStepViewController.h