BackgroundTask class

A task which specifies that all containing measures and/or outputs should immediately start running in the background once triggered. The task runs for the specified duration, or until stopped, or until all measures and/or outputs have completed.

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


BackgroundTask({String? name, String? description, List<Measure>? measures, IsoDuration? duration})
Create a new task which can run in the background.
BackgroundTask.fromJson(Map<String, dynamic> json)


$type String?
The runtime class name (type) of this object. Used for deserialization from JSON objects.
getter/setter pairinherited
description String?
A description of this task, emphasizing the reason why the data is collected.
getter/setter pairinherited
duration ↔ IsoDuration?
The optional duration over the course of which the measures need to be sampled. Duration is specified in the ISO 8061 standard. Null implies infinite by default.
getter/setter pair
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
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>?
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


addMeasure(Measure measure) → void
Add measure to this task.
addMeasures(Iterable<Measure> list) → void
Add a list of measures to this task.
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.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
removeMeasure(Measure measure) → void
Remove measure from this task.
toJson() Map<String, dynamic>
Return a JSON encoding of this object.
toString() String
A string representation of this object.


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