RPTimerStep class

A step where the user is forced to wait for timeout before being allowed to proceed to the next step.

Inheritance
Annotations
  • @JsonSerializable(includeIfNull: false, explicitToJson: true)

Constructors

RPTimerStep({required String identifier, required String title, bool optional = false, required Duration timeout, bool playSound = false, bool autoSkip = false, bool showTime = true, String? footnote})
Creates a RPTimerStep with an identifier, title and timeout.
RPTimerStep.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
autoSkip ↔ bool
Automatically move to the next step once finished counting down? False by default.
getter/setter pair
footnote ↔ String?
Optional footer text to be displayed below the question. This can be used to provide additional information, such as copyright, or instructions. This text will be displayed in a smaller font size.
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 Step. This identifier connects the step to its result (RPResult) object.
finalinherited
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
optional ↔ bool
Can this step be skipped? If so, the result for the step will be null.
getter/setter pairinherited
playSound ↔ bool
Play a sound when the timer has finished counting down? False by default.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showTime ↔ bool
Should the remaining time be shown while counting down? If false only the title will be shown. True by default.
getter/setter pair
stepWidget → Widget
The widget (UI representation) of the step.
no setteroverride
text ↔ String?
The text of the Step. Different types of Steps are using the text text differently.
getter/setter pairinherited
timeout ↔ Duration
The time the user must wait before being able to continue.
getter/setter pair
timer ↔ Timer?
getter/setter pairinherited
title ↔ String
The title text. Different types of Steps are using the title text differently.
getter/setter pairinherited

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