ORKNavigablePageStep Class Reference

Inherits from	ORKPageStep : ORKStep : NSObject
Declared in	ORKNavigablePageStep.h ORKNavigablePageStep.m

Overview

The ORKNavigablePageStep class is a concrete subclass of ORKPageStep, used for presenting a subgrouping of ORKStepViewController views using a UIPageViewController. It allows for using an ORKOrderedTask as the model object used to define navigation, and has been added specifically to allow developers to use ORKNavigableOrderedTask and other subclasses of ORKOrderedTask with the ORKPageStep.

To use ORKNavigablePageStep, instantiate the object, fill in its properties, and include it in a task. Next, create a task view controller for the task and present it.

The base class implementation will instatiate a read-only ORKPageStepViewController to display a series of substeps. For each substep, the ORKStepViewController will be instantiated and added as a child of the UIPageViewController contained by the parent ORKPageStepViewController..

Customization can be handled by overriding the base class implementations in either ORKNavigablePageStep or ORKPageStepViewController.

Other Methods

`– initWithIdentifier:`

- (instancetype)initWithIdentifier:(NSString *)identifier

Declared In

ORKStep.h

`– initWithIdentifier:steps:`

Returns an initialized page step using the specified identifier and array of steps.

- (instancetype)initWithIdentifier:(NSString *)identifier steps:(NSArray<ORKStep*> *)steps

Parameters

`identifier`	The unique identifier for the step.
`steps`	An array of `ORKStep` objects in the order in which they should be presented.

Return Value

An initialized page step.

Declared In

ORKPageStep.h

`– initWithIdentifier:pageTask:`

Returns an initialized page step using the specified identifier and task.

- (instancetype)initWithIdentifier:(NSString *)identifier pageTask:(ORKOrderedTask *)task

Parameters

`identifier`	The unique identifier for the step.
`task`	The task used to run the subtask.

Return Value

An initialized navigable page step.

Declared In

ORKNavigablePageStep.h

`– initWithCoder:`

Returns a page step initialized from data in the given unarchiver.

- (instancetype)initWithCoder:(NSCoder *)aDecoder

Parameters

`aDecoder`	The coder from which to initialize the ordered task.

Return Value

An initialized navigable page step.

Discussion

A page step can be serialized and deserialized with NSKeyedArchiver. Note that this serialization includes strings that might need to be localized.

Declared In

ORKNavigablePageStep.h

Other Methods

`pageTask`

The subtask used to determine the next/previous steps that are in this grouping

@property (nonatomic, copy, readonly) ORKOrderedTask *pageTask

Declared In

ORKNavigablePageStep.h