RPOrderedTask class

A simple linear task which implement the RPTask protocol. It shows the steps one after another without the option of going back or branching.

For simple tasks the RPOrderedTask is perfect. For more features (going back to previous questions, branching...) consider using RPNavigableOrderedTask which inherited from this class.

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

Constructors

RPOrderedTask({required String identifier, required List<RPStep> steps, bool closeAfterFinished = true})
RPOrderedTask.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 pairinherited
closeAfterFinished ↔ bool
If set to true the Task will close after the participant has finished the task. If it's set to false no navigation function is called.
getter/setter pairinherited
fromJsonFunction → Function
The function which can convert a JSON string to an object of this type.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
identifier ↔ String
A unique identifier of the Task. This identifier connects the Task to its result (RPTaskResult) object.
getter/setter pairinherited
isConsentTask → bool
Returns true if the task is a Consent Task. It is considered a Consent Task if it has an RPConsentReviewStep
no setter
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 setterinherited
numberOfQuestionSteps → int
The number of question steps in the task
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
steps ↔ List<RPStep>
The list of RPSteps of the task
getter/setter pair

Methods

getStepAfterStep(RPStep? step, RPTaskResult? result) → RPStep?
Returns the step after a specified step if there's any. If the specified step is null then it returns the first step.
override
getStepBeforeStep(RPStep? step, RPTaskResult? result) → RPStep?
Returns the step that precedes the specified step, if there is one. If the specified step is null then it returns the last step.
override
getStepWithIdentifier(String identifier) → RPStep?
Returns the step that matches the specified identifier. Returns null if there is no step with the identifier.
override
getTitleForStep(RPStep step) → String
Returns the title of a given step
override
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