ORKTouchRecorder Class Reference

Inherits from	ORKRecorder : NSObject
Declared in	ORKTouchRecorder.h ORKTouchRecorder.m

Overview

The ORKTouchRecorder class defines the attributes and behavior of touch events recorder.

This class is considered private because its interface is not yet considered stable. It is not currently used by any of the pre-defined active tasks.

Other Methods

`– viewController:willStartStepWithView:`

A preparation step to provide viewController and view before record starting.

- (void)viewController:(UIViewController *)viewController willStartStepWithView:(UIView *)view

Parameters

`viewController`	The view controller that is about to ‘start’
`view`	Primary active view for the step.

Discussion

The step view controller should call this method before starting the recorder, so that recorders that need a view or gesture recognizer in order to function can attach themselves.

Declared In

ORKRecorder_Private.h

`– start`

Starts data recording.

- (void)start

Discussion

If an error occurs when recording starts, it is returned through the delegate.

Declared In

ORKRecorder.h

`– stop`

Stops data recording, which generally triggers the return of results.

- (void)stop

Discussion

If an error occurs when stopping the recorder, it is returned through the delegate. Subclasses should call finishRecordingWithError: rather than calling super.

Declared In

ORKRecorder.h

`– finishRecordingWithError:`

Indicates that recording has failed; stop recording and report the error to the delegate

- (void)finishRecordingWithError:(NSError *)error

Parameters

`error`	Error that occurred.

Declared In

ORKRecorder_Private.h

Other Methods

`touchView`

The ORKTouchRecorder attaches a gesture recognizer to touchView to receive touch events.

@property (nonatomic, strong, readonly, nullable) UIView *touchView

Discussion

Use viewController:willStartStepWithView: to set the touchView property before the touch recorder starts.

Declared In

ORKTouchRecorder.h