ORKPasscodeStepViewController Class Reference

Inherits from ORKStepViewController : UIViewController
Declared in ORKPasscodeStepViewController.h
ORKPasscodeStepViewController.m

Overview

An ORKPasscodeStepViewController object is the view controller for an ORKPasscodeStep object.

A passcode view controller can be instantiated indirectly by adding a passcode step to a consent task and present the task using a task view controller. When appropriate, the task view controller instantiates the step view controller for the step.

– 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

– addResult:

Add a result to the step view controller’s ORKStepResult. By default, the property for the step view controller’s result will instantiate a copy of the result each time it is called. Therefore, the result cannot be mutated by adding a result to its result array.

- (void)addResult:(ORKResult *)result

Parameters

result

The result to add to the step results.

Discussion

This method can be called by a delegate to add a result to a given step in a way that will be retained by the step.

Declared In

ORKStepViewController.h

– promptTouchIdWithDelay

Device does not support Touch ID.

- (void)promptTouchIdWithDelay

Declared In

ORKPasscodeStepViewController.m

+ savePasscode:withTouchIdEnabled:

Stores the given passcode as the user’s unlock passcode to the keychain.

+ (void)savePasscode:(NSString *)passcode withTouchIdEnabled:(BOOL)touchIdEnabled

Parameters

passcode

The passcode to store

touchIdEnabled

Whether TouchId will be available during passcode entry

Discussion

This method will raise an exception if passcode is nil.

Declared In

ORKPasscodeStepViewController_Internal.h