RPStep class

The base class for steps which can compose a task.

Each RPStep object represents one logical piece of data entry or activity in a larger task. Whether your app is giving instructions, presenting a form or survey, obtaining consent, or running an active task, everything in the Research Package framework is a collection of steps (RPStep objects), which together form a task (an RPTask object)

Inheritance

• Object
• Serializable
• RPStep

Implementers

• RPActivityStep
• RPCompletionStep
• RPConsentReviewStep
• RPInstructionStep
• RPQuestionStep
• RPTimerStep
• RPVisualConsentStep

Annotations

• @JsonSerializable(fieldRename: FieldRename.snake, includeIfNull: false)

Constructors

RPStep.new({required String identifier, required String title, String? text, bool optional = false})

Create a step object with the given title. Different types of Steps are using the title text differently.

RPStep.fromJson(Map<String, dynamic> json)

factory

Properties

$type ↔ String?

The runtime class name (type) of this object. Used for deserialization from JSON objects.

getter/setter pair, inherited

fromJsonFunction → Function

The function which can convert a JSON string to an object of this type.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

identifier → String

A unique identifier of the Step. This identifier connects the Step to its result (RPResult) object.

final

jsonType → String

Return the __type to be used for JSON serialization of this class. Default is runtimeType. Only specify this if you need another type.

no setter, inherited

optional ↔ bool

If set to true the step can be skipped. In that case the result for the step will be null.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stepWidget → Widget

The widget (UI representation) of the step. RPQuestionSteps don't have it because their UI representation depends on the Answer Format. Their Answer Format is assessed by RPUIQuestionStep or RPUIFormStep and they return the corresponding UI.

no setter

text ↔ String?

The text of the Step. Different types of Steps are using the text text differently.

getter/setter pair

title ↔ String

The title text. Different types of Steps are using the title text differently.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Return a JSON encoding of this object.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited