FunctionTask class
A task that can run a custom Dart function.
Note that the function to be executed is specified as a Dart function,
which cannot be serialized to/from JSON.
Thus, even though this trigger can be de/serialized from/to JSON, its
function cannot.
This implies that this function cannot be retrieved as part of a StudyProtocol
from a DeploymentService
since it relies on specifying a Dart-specific function.
Hence, this trigger is mostly useful when creating a StudyProtocol
directly
in the app using Dart code.
- Inheritance
-
- Object
- Serializable
- TaskDescriptor
- FunctionTask
- Annotations
-
- @JsonSerializable(fieldRename: FieldRename.snake, includeIfNull: false)
Constructors
- FunctionTask({String? name, VoidFunction? function})
- Create a function task that executed function when resumed.
-
FunctionTask.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
- fromJsonFunction → Function
-
The function which can convert a JSON string to an object of this type.
no setteroverride
- function ↔ VoidFunction?
-
The function to execute when this task is resumed.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- 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 -
measures
↔ List<
Measure> -
A list of
Measure
s to be done as part of this task.getter/setter pairinherited - name ↔ String
-
The name of this task. Unique for this
StudyProtocol
.getter/setter pairinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addMeasure(
Measure measure) → void -
Add a
Measure
to this task.inherited -
addMeasures(
Iterable< Measure> list) → void -
Add a list of
Measure
s to this task.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeMeasure(
Measure measure) → void -
Remove a
Measure
from this task.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