ORKRegistrationStep Class Reference

Inherits from ORKFormStep : ORKStep : NSObject
Declared in ORKRegistrationStep.h
ORKRegistrationStep.m

Overview

The ORKRegistrationStep class represents a form step that provides fields commonly used for account registration.

The registration step contains email and password fields by default. Optionally, any of the additional fields can be included based on context and requirements.

Other Methods

– initWithIdentifier:title:text:passcodeValidationRegularExpression:passcodeInvalidMessage:options:

Returns an initialized registration step using the specified identifier, title, text, options, passcodeValidationRegularExpression, and passcodeInvalidMessage.

- (instancetype)initWithIdentifier:(NSString *)identifier title:(NSString *)title text:(NSString *)text passcodeValidationRegularExpression:(NSRegularExpression *)passcodeValidationRegularExpression passcodeInvalidMessage:(NSString *)passcodeInvalidMessage options:(ORKRegistrationStepOption)options

Parameters

identifier

The string that identifies the step (see ORKStep).

title

The title of the form (see ORKStep).

text

The text shown immediately below the title (see ORKStep).

passcodeValidationRegularExpression

The regular expression used to validate the passcode form item (see ORKTextAnswerFormat).

passcodeInvalidMessage

The invalid message displayed for invalid input (see ORKTextAnswerFormat).

options

The options used for the step (see ORKRegistrationStepOption).

Return Value

An initialized registration step object.

Declared In

ORKRegistrationStep.h

– initWithIdentifier:title:text:options:

Returns an initialized registration step using the specified identifier, title, text, and options.

- (instancetype)initWithIdentifier:(NSString *)identifier title:(NSString *)title text:(NSString *)text options:(ORKRegistrationStepOption)options

Parameters

identifier

The string that identifies the step (see ORKStep).

title

The title of the form (see ORKStep).

text

The text shown immediately below the title (see ORKStep).

options

The options used for the step (see ORKRegistrationStepOption).

Return Value

An initialized registration step object.

Declared In

ORKRegistrationStep.h

– initWithIdentifier:title:text:

Returns an initialized form step using the specified identifier, title, and text.

- (instancetype)initWithIdentifier:(NSString *)identifier title:(NSString *)title text:(NSString *)text

Parameters

identifier

The string that identifies the step (see ORKStep).

title

The title of the form (see ORKStep).

text

The text shown immediately below the title (see ORKStep).

Return Value

As initialized form step object.

Declared In

ORKFormStep.h

– initWithIdentifier:

- (instancetype)initWithIdentifier:(NSString *)identifier

Declared In

ORKStep.h

– formItems

The array of items in the form.

- (NSArray<ORKFormItem*> *)formItems

Discussion

A form step that contains no items is considered invalid and an exception will be thrown when it is presented.

Declared In

ORKFormStep.h

– passcodeValidationRegularExpression

The regular expression used to validate the passcode form item. This is a transparent property pointing to its definition in ORKTextAnswerFormat.

- (NSRegularExpression *)passcodeValidationRegularExpression

Discussion

The passcode invalid message property must also be set along with this property. By default, there is no validation on the passcode.

Declared In

ORKRegistrationStep.h

– passcodeInvalidMessage

The invalid message displayed if the passcode does not match the validation regular expression. This is a transparent property pointing to its definition in ORKTextAnswerFormat.

- (NSString *)passcodeInvalidMessage

Discussion

The passcode validation regular expression property must also be set along with this property. By default, there is no invalid message.

Declared In

ORKRegistrationStep.h

– phoneNumberValidationRegularExpression

The regular expression used to validate the phone number form item. This is a transparent property pointing to its definition in ORKTextAnswerFormat.

- (NSRegularExpression *)phoneNumberValidationRegularExpression

Discussion

The phone number invalid message property must also be set along with this property. By default, there is no validation on the phone number.

Declared In

ORKRegistrationStep.h

– phoneNumberInvalidMessage

The invalid message displayed if the phone number does not match the validation regular expression. This is a transparent property pointing to its definition in ORKTextAnswerFormat.

- (NSString *)phoneNumberInvalidMessage

Discussion

The phone number validation regular expression property must also be set along with this property. By default, there is no invalid message.

Declared In

ORKRegistrationStep.h

– initWithCoder:

- (instancetype)initWithCoder:(NSCoder *)aDecoder

Declared In

ORKStep.h

Other Methods

  options

The options used for the step.

@property (nonatomic, readonly) ORKRegistrationStepOption options

Discussion

These options allow one or more fields to be included in the registration step.

Declared In

ORKRegistrationStep.h