# Health data mode

Canonical page: https://docs.ovok.com/flutter-sdk/reference/ovok_flutter/health-data-mode

{/* Generated by scripts/generate_reference.dart; do not edit. */}

## HealthDataMode [#healthdatamode]

```dart
enum HealthDataMode
```

How a health data type is converted into observations.

### Values [#values]

#### HealthDataMode.point [#healthdatamodepoint]

```dart
static const HealthDataMode point
```

One observation for each source record.

#### HealthDataMode.dailyTotal [#healthdatamodedailytotal]

```dart
static const HealthDataMode dailyTotal
```

One total for each local calendar day.

#### HealthDataMode.dailySummary [#healthdatamodedailysummary]

```dart
static const HealthDataMode dailySummary
```

One summary for each local calendar day.

#### HealthDataMode.session [#healthdatamodesession]

```dart
static const HealthDataMode session
```

One observation for each source session.

#### HealthDataMode.series [#healthdatamodeseries]

```dart
static const HealthDataMode series
```

One observation per finished hour with one value per minute.

### Constructors [#constructors]

#### HealthDataMode.new [#healthdatamodenew]

```dart
HealthDataMode(String value)
```

Creates a health data mode with its Native contract value.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `value` | `String` | positional |  |

### Properties [#properties]

#### HealthDataMode.value [#healthdatamodevalue]

```dart
final String value
```

Value used by the Native data-sync contract.


## HealthDataType [#healthdatatype]

```dart
enum HealthDataType
```

Health-only data types that are not Core measurement services.

### Values [#values-1]

#### HealthDataType.height [#healthdatatypeheight]

```dart
static const HealthDataType height
```

Body height.

#### HealthDataType.bodyFatPercentage [#healthdatatypebodyfatpercentage]

```dart
static const HealthDataType bodyFatPercentage
```

Body fat percentage.

#### HealthDataType.bodyMassIndex [#healthdatatypebodymassindex]

```dart
static const HealthDataType bodyMassIndex
```

Body mass index.

#### HealthDataType.leanBodyMass [#healthdatatypeleanbodymass]

```dart
static const HealthDataType leanBodyMass
```

Lean body mass.

#### HealthDataType.distance [#healthdatatypedistance]

```dart
static const HealthDataType distance
```

Distance walked or run.

#### HealthDataType.activeEnergy [#healthdatatypeactiveenergy]

```dart
static const HealthDataType activeEnergy
```

Active energy burned.

#### HealthDataType.flightsClimbed [#healthdatatypeflightsclimbed]

```dart
static const HealthDataType flightsClimbed
```

Flights of stairs climbed.

#### HealthDataType.exerciseMinutes [#healthdatatypeexerciseminutes]

```dart
static const HealthDataType exerciseMinutes
```

Minutes of exercise.

#### HealthDataType.heartRateSummary [#healthdatatypeheartratesummary]

```dart
static const HealthDataType heartRateSummary
```

Summary of heart rate over a period.

#### HealthDataType.sleep [#healthdatatypesleep]

```dart
static const HealthDataType sleep
```

Sleep sessions.

#### HealthDataType.workout [#healthdatatypeworkout]

```dart
static const HealthDataType workout
```

Workout sessions.

#### HealthDataType.water [#healthdatatypewater]

```dart
static const HealthDataType water
```

Water drunk.

#### HealthDataType.carbohydrates [#healthdatatypecarbohydrates]

```dart
static const HealthDataType carbohydrates
```

Carbohydrates eaten.

#### HealthDataType.caloriesEaten [#healthdatatypecalorieseaten]

```dart
static const HealthDataType caloriesEaten
```

Food energy eaten.

#### HealthDataType.bloodAlcohol [#healthdatatypebloodalcohol]

```dart
static const HealthDataType bloodAlcohol
```

Blood alcohol content.

#### HealthDataType.insulin [#healthdatatypeinsulin]

```dart
static const HealthDataType insulin
```

Insulin delivered.

### Constructors [#constructors-1]

#### HealthDataType.new [#healthdatatypenew]

```dart
HealthDataType(String key)
```

Creates a health-only type with its Native contract key.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `key` | `String` | positional |  |

### Properties [#properties-1]

#### HealthDataType.key [#healthdatatypekey]

```dart
final String key
```

Key used in health sync configuration and progress maps.


## HealthSyncKey [#healthsynckey]

```dart
typedef HealthSyncKey = String
```

A Core measurement key or a [`HealthDataType.key`](#healthdatatypekey).


## getHealthDataMode [#gethealthdatamode]

```dart
HealthDataMode getHealthDataMode(HealthSyncKey key, {HealthDataMode? configuredMode})
```

Returns the configured mode, or the default mode for `key`.

| Parameter | Type | Kind | Default |
| ------ | ------ | ------ | ------ |
| `key` | `HealthSyncKey` | positional |  |
| `configuredMode` | `HealthDataMode?` | named |  |