HealthProbe class

A probe collecting health data from Apple Health or Google Health Connect.

Configuration of this probe is based on a HealthSamplingConfiguration which again is a HistoricSamplingConfiguration. This means that when started, it will try to collect data back to the last time data was collected. Hence, this probe is suited for configuration using a trigger that collects data on a regular basis. This could be a PeriodicTrigger or it could be configured as an AppTask asking the user to collect the data on a regular basis.

Note that even though this probe is a StreamProbe, the health measure is a one-time measure, which needs to be triggered to collect the data. The stream probe is used since this probe can return a lot of health data, which need to be streamed back to the mobile sensing framework.

Inheritance
  • Object
  • AbstractExecutor<Measure>
  • Probe
  • StreamProbe
  • HealthProbe

Constructors

HealthProbe()

Properties

configuration → Measure?
The configuration of this executor as set when initialized.
no setterinherited
deployment → SmartphoneDeployment?
The deployment that this executor is part of executing.
no setterinherited
deviceManager HealthServiceManager
The device that this probes uses to collect data.
getter/setter pairinherited-setteroverride-getter
enabled bool
Is this probe enabled, i.e. available for collection of data using the start method.
getter/setter pairinherited
hashCode int
The hash code for this object.
no setterinherited
isStarting bool
Is this executor in the process of being started?
no setterinherited
measure → Measure?
The Measure that configures this probe.
no setterinherited
measurements Stream<Measurement>
The stream of Measurement collected by this executor.
no setterinherited
permissions List<Permission>
The list of permissions needed for this probe.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
samplingConfiguration HealthSamplingConfiguration
The sampling configuration for this probe.
no setteroverride
state → ExecutorState
The runtime state of this executor.
no setterinherited
stateEvents Stream<ExecutorState>
The runtime state changes of this executor.
no setterinherited
stream Stream<Measurement>
The stream of Measurement objects for this StreamProbe. Must be implemented by sub-classes.
no setteroverride
type String?
The data type this probe is collecting.
no setterinherited

Methods

addError(Object error, [StackTrace? stacktrace]) → void
Add an error to the measurements stream.
inherited
addMeasurement(Measurement measurement) → void
Add a data point to the measurements stream.
inherited
arePermissionsGranted() Future<bool>
Does this probe has the permissions needed to run?
inherited
dispose() → void
Dispose of this executor.
inherited
error() → void
inherited
initialize(Measure configuration, [SmartphoneDeployment? deployment]) → void
Configure and initialize the executor before starting it.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose() Future<void>
Callback when this executor is disposed.
inherited
onInitialize() bool
Callback when this executor is initialized. Returns true if successfully initialized, false otherwise.
override
onRestart() Future<bool>
Callback when this executor is to be restarted. Returns true if the executor is ready to restart (default), false otherwise.
inherited
onStart() Future<bool>
Callback when this executor is started. Returns true if successfully started, false otherwise.
override
onStop() Future<bool>
Callback when this executor is stopped. Returns true if successfully stopped, false otherwise.
inherited
requestPermissions() Future<bool>
Request permission to access health data specified in the samplingConfiguration.
override
restart() → void
Restart the executor.
inherited
start() → void
Start the executor.
inherited
stop() → void
Stop the executor. Stopped until start or restart is called.
inherited
toString() String
A string representation of this object.
inherited
validateHealthDataTypes() → void
Check if the sampling configuration contains a valid list of HealthDataType for the current platform (iOS or Android).

Operators

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