ORKLocationRecorderConfiguration Class Reference
| Inherits from | ORKRecorderConfiguration : NSObject |
|---|---|
| Declared in | ORKLocationRecorder.m ORKRecorder.h |
Overview
The ORKLocationRecorderConfiguration class represents a configuration
that records location data during an active step.
The location data reported is the location provided by CoreLocation.
If this configuration is included in an active step in a task, the task view controller requests access to location data at the end of the initial instruction steps in the task.
Location data is serialized to JSON and returned as an ORKFileResult object.
For details on the format, see CLLocation+ORKJSONDictionary.
To use a recorder, include its configuration in the recorderConfigurations property
of an ORKActiveStep object, include that step in a task, and present it with
a task view controller.
No additional parameters besides the identifier are required.
– initWithIdentifier:
Returns an initialized location recorder configuration.
- (instancetype)initWithIdentifier:(NSString *)identifierParameters
identifier |
The unique identifier of the recorder configuration. |
|---|
Return Value
An initialized location recorder configuration.
Discussion
This method is the designated initializer.
Declared In
ORKRecorder.h
– recorderForStep:outputDirectory:
Returns a recorder instance using this configuration.
- (ORKRecorder *)recorderForStep:(ORKStep *)step outputDirectory:(NSURL *)outputDirectoryParameters
step |
The step for which this recorder is being created. |
|---|---|
outputDirectory |
The directory in which all output file data should be written (if producing |
Return Value
A configured recorder instance.
Declared In
ORKRecorder.h
– initWithCoder:
Returns a new location recorder configuration initialized from data in the given unarchiver.
- (instancetype)initWithCoder:(NSCoder *)aDecoderParameters
aDecoder |
Coder from which to initialize the location recorder configuration. |
|---|
Return Value
A new location recorder configuration.
Declared In
ORKRecorder.h
– requestedPermissionMask
Returns the permission mask indicating the permissions required for this configuration.
- (ORKPermissionMask)requestedPermissionMaskDiscussion
This method is typically overridden in new recorder configuration subclasses.
Declared In
ORKRecorder_Private.h