ORKHealthClinicalTypeRecorder Class Reference

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

Overview

The ORKHealthClinicalTypeRecorder class represents a recorder for collecting health records data from HealthKit during an active task.

– initWithIdentifier:healthClinicalType:healthFHIRResourceType:step:outputDirectory:

Returns an initialized health clinical type recorder using the specified HKClinicalType and HKFHIRResourceType.

- (instancetype)initWithIdentifier:(NSString *)identifier healthClinicalType:(HKClinicalType *)healthClinicalType healthFHIRResourceType:(nullable HKFHIRResourceType)healthFHIRResourceType step:(ORKStep *)step outputDirectory:(NSURL *)outputDirectory

Parameters

identifier

The unique identifier of the recorder (assigned by the recorder configuration).

healthClinicalType

The HKClinicalType data that should be collected during the active task.

healthFHIRResourceType

The HKFHIRResourceType for the predicate used to query the HKClinicalType.

step

The step that requested this recorder.

outputDirectory

The directory in which the health records data queried from HealthKit should be stored.

Return Value

An initialized health quantity type recorder.

Declared In

ORKHealthClinicalTypeRecorder.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

– isRecording

A Boolean value indicating whether the recorder is currently recording.

- (BOOL)isRecording

Return Value

YES if the recorder is recording; otherwise, NO.

Declared In

ORKRecorder.h