ORKInstructionStep Class Reference

Inherits from	ORKStep : NSObject
Declared in	ORKInstructionStep.h ORKInstructionStep.m

Overview

An ORKInstructionStep object gives the participant instructions for a task.

You can use instruction steps to present various types of content during a task, such as introductory content, instructions in the middle of a task, or a final message at the completion of a task.

To indicate the completion of a task, consider using an ORKCompletionStep object instead.

Other Methods

`+ stepViewControllerClass`

+ (Class)stepViewControllerClass

Declared In

ORKStep.h

`– initWithCoder:`

- (instancetype)initWithCoder:(NSCoder *)aDecoder

Declared In

ORKStep.h

Other Methods

`detailText`

Additional detailed explanation for the instruction.

@property (nonatomic, copy, nullable) NSString *detailText

Discussion

The detail text is displayed below the content of the text property.

Declared In

ORKInstructionStep.h

`attributedDetailText`

Additional attributed explanation for the instruction.

@property (nonatomic, copy, nullable) NSAttributedString *attributedDetailText

Discussion

The attributed detail text is displayed below the content of the text property and overrides detailText.

Declared In

ORKInstructionStep.h

`footnote`

Additional text to display for the step in a localized string at the bottom of the view.

@property (nonatomic, copy, nullable) NSString *footnote

Discussion

The footnote is displayed in a smaller font below the continue button. It is intended to be used in order to include disclaimer, copyright, etc. that is important to display in the step but should not distract from the main purpose of the step.

Declared In

ORKInstructionStep.h

`image`

An image that provides visual context for the instruction.

@property (nonatomic, copy, nullable) UIImage *image

Discussion

The image is displayed with aspect fit. Depending on the device, the screen area available for this image can vary. For exact metrics, see ORKScreenMetricIllustrationHeight.

Declared In

ORKInstructionStep.h

`auxiliaryImage`

An image that provides visual context for the instruction that will allow for showing a two-part composite image where the image is tinted and the auxiliaryImage is shown with light grey.

@property (nonatomic, copy, nullable) UIImage *auxiliaryImage

Discussion

The image is displayed with the same frame as the image so both the auxiliaryImage and image should have transparently to allow for overlay.

Declared In

ORKInstructionStep.h

`iconImage`

Optional icon image to show above the title and text.

@property (nonatomic, copy, nullable) UIImage *iconImage

Declared In

ORKInstructionStep.h