ORKSpeechRecognitionStepViewController Class Reference

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

Overview

Step view controller corresponding to ORKSpeechRecognitionStep.

– 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

– recordersDidChange

Tells the view controller that the set of recorders changed.

- (void)recordersDidChange

Discussion

This method is usually called by the active step view controller in response to start or resume.

Subclasses may override 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

– 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

– goForward

Navigates forward to the next step.

- (void)goForward

Discussion

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.

Declared In

ORKStepViewController.h

– stepDidFinish

Tells the view controller that the active step has finished.

- (void)stepDidFinish

Discussion

This method is an override point for subclasses, called by the base class when the step has just finished.

The default implementation does nothing except in the case of steps that have countdown enabled. When countdown is enabled in a step, the view controller attempts to navigate automatically to the next step, if so configured.

Declared In

ORKActiveStepViewController.h

– recordersWillStart

Tells the view controller that the recorders are about to start.

- (void)recordersWillStart

Discussion

This method is called by the active step view controller after instantiating the recorders, but before starting them.

Subclasses may override this method.

Declared In

ORKActiveStepViewController.h