ORKLoginStep Class Reference
Inherits from | ORKFormStep : ORKStep : NSObject |
---|---|
Declared in | ORKLoginStep.h ORKLoginStep.m |
Overview
The ORKLoginStep
class represents a form step that provides fields commonly used
for account login.
The login step contains email and password fields.
Other Methods
– initWithIdentifier:
- (instancetype)initWithIdentifier:(NSString *)identifier
Declared In
ORKStep.h
– initWithIdentifier:title:text:
Returns an initialized form step using the specified identifier, title, and text.
- (instancetype)initWithIdentifier:(NSString *)identifier title:(nullable NSString *)title text:(nullable NSString *)text
Parameters
identifier |
The string that identifies the step (see |
---|---|
title |
The title of the form (see |
text |
The text shown immediately below the title (see |
Return Value
As initialized form step object.
Declared In
ORKFormStep.h
– initWithIdentifier:title:text:loginViewControllerClass:
Returns an initialized login step using the specified identifier, title, text, and options.
- (instancetype)initWithIdentifier:(NSString *)identifier title:(nullable NSString *)title text:(nullable NSString *)text loginViewControllerClass:(Class)loginViewControllerClass
Parameters
identifier |
The string that identifies the step (see |
---|---|
title |
The title of the form (see |
text |
The text shown immediately below the title (see |
loginViewControllerClass |
The subclassed login step view controller class. |
Return Value
An initialized login step object.
Declared In
ORKLoginStep.h
loginViewControllerClass
The view controller subclass used for the step.
@property (nonatomic, readonly) Class loginViewControllerClass
Discussion
The subclass allows you to override button actions in order to provide navigation logic for the button items on the step.
Declared In
ORKLoginStep.h
Other Methods
– validateParameters
Checks the parameters of the step and throws exceptions on invalid parameters.
- (void)validateParameters
Discussion
This method is called when there is a need to validate the step’s parameters, which is typically
the case when adding a step to an ORKStepViewController
object, and when presenting the
step view controller.
Subclasses should override this method to provide validation of their additional properties, and must call super.
Declared In
ORKStep.h
– isOptional
A Boolean value indicating whether the user can skip the step without providing an answer.
- (BOOL)isOptional
Discussion
The default value of this property is YES
. When the value is NO
, the Skip button does not
appear on this step.
This property may not be meaningful for all steps; for example, an active step might not provide a way to skip, because it requires a timer to finish.
Declared In
ORKStep.h