FunctionTask class

A task that can run a custom Dart function.

The function runs each time the task is resumed, see FunctionTaskExecutor. The function cannot be serialized to/from JSON, so it is lost when the protocol is stored or retrieved from a DeploymentService. Use this task only in a StudyProtocol built in Dart code in the app.

Inheritance
  • Object
  • Serializable
  • TaskConfiguration
  • FunctionTask
Annotations
  • @JsonSerializable.new(includeIfNull: false, explicitToJson: true)

Constructors

FunctionTask({String? name, String? description, VoidFunction? function})
Creates a function task that executes function when resumed.
FunctionTask.fromJson(Map<String, dynamic> json)
factory

Properties

$type ↔ String?
The type name written to __type in JSON; set to jsonType on creation.
getter/setter pairinherited
description ↔ String?
A description of this task, emphasizing the reason why the data is collected.
getter/setter pairinherited
fromJsonFunction → Function
The generated function that converts a JSON map to an object of this type.
no setteroverride
function ↔ void Function()?
The function to execute when this task is resumed.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
jsonType → String
The __type used for JSON serialization of this class.
no setterinherited
measures ↔ List<Measure>?
The data which needs to be collected/measured passively as part of this task.
getter/setter pairinherited
name ↔ String
A name which uniquely identifies the task.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addMeasure(Measure measure) → void
Add measure to this task.
inherited
addMeasures(Iterable<Measure> list) → void
Add a list of measures to this task.
inherited
getAllExpectedDataTypes() → Set<String>
Get data types of all data which may be collected, either passively as part of task measures, or as the result of user interactions, for this task.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeMeasure(Measure measure) → void
Remove measure from this task.
inherited
toJson() → Map<String, dynamic>
Returns a JSON map of this object, including the __type property.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited