Health import

HealthImportAccessStatusCopy Anchor Link

enum HealthImportAccessStatus

Health-source access state for one data type.

ValuesCopy Anchor Link

HealthImportAccessStatus.authorizedCopy Anchor Link

static const HealthImportAccessStatus authorized

The app can read this data type.

HealthImportAccessStatus.shouldRequestCopy Anchor Link

static const HealthImportAccessStatus shouldRequest

The app can request access to this data type.

HealthImportAccessStatus.refusedCopy Anchor Link

static const HealthImportAccessStatus refused

The user did not grant access to this data type.

HealthImportAccessStatus.unsupportedCopy Anchor Link

static const HealthImportAccessStatus unsupported

The active health source does not provide this data type.

HealthImportAdapterCopy Anchor Link

abstract interface class HealthImportAdapter<TType>

Reads and requests access to one health data type.

MethodsCopy Anchor Link

HealthImportAdapter.getStatusCopy Anchor Link

Future<HealthImportAccessStatus> getStatus(TType type)

Returns the current access status of type.

Returns Future<HealthImportAccessStatus>.

HealthImportAdapter.requestCopy Anchor Link

Future<void> request(List<TType> types, {required bool background})

Requests access to types, optionally including background reading.

Returns Future<void>.

HealthImportControllerCopy Anchor Link

class HealthImportController<TType> extends ChangeNotifier

Tracks health import access and requests permission when import is enabled.

ConstructorsCopy Anchor Link

HealthImportController.newCopy Anchor Link

HealthImportController<TType>({
  required Iterable<TType> types,
  required HealthImportAdapter<TType> adapter,
  bool background = false,
})

Creates a controller for types using adapter.

PropertiesCopy Anchor Link

HealthImportController.typesCopy Anchor Link

final List<TType> types

Data types managed by this controller.

HealthImportController.backgroundCopy Anchor Link

final bool background

Whether the health source should allow reading data in the background.

HealthImportController.enabledCopy Anchor Link

bool get enabled

Whether health import is switched on.

HealthImportController.statusByTypeCopy Anchor Link

Map<TType, HealthImportAccessStatus> get statusByType

Access status for each type whose status was read successfully.

HealthImportController.notSharedCopy Anchor Link

List<TType> get notShared

Data types that the user has not shared.

HealthImportController.errorCopy Anchor Link

Object? get error

Error from the last status check or access request.

MethodsCopy Anchor Link

HealthImportController.refreshCopy Anchor Link

Future<void> refresh()

Refreshes access status for all configured types.

Returns Future<void>.

HealthImportController.setEnabledCopy Anchor Link

Future<void> setEnabled(bool enabled)

Requests access before switching import on; switches off without a request.

Returns Future<void>.