AFCore/com.advantahealth.api.health.model/UnitTypes

UnitTypes

Unit of measure for a health metric.

Accompanies the numeric values returned in health and activity payloads so a consumer can render the correct suffix and convert between systems without guessing from context. Group the values by what they measure:

Distance: METER, KILOMETER, MILE
Duration: SECOND, MINUTE, HOUR
Energy: CALORIE, KILOCALORIE
Count: STEP
Mass: POUND, OUNCE, KILOGRAM
Temperature: DEGREE_CELSIUS, DEGREE_FAHRENHEIT
Ratio: PERCENTAGE

The SDK does not convert between units on your behalf — render or convert using whichever member-facing system (metric/imperial) your app prefers.

Entries

METER

Distance in meters (SI base unit of length).

MILE

Distance in statute miles (~1609.34 meters). Common for US members.

KILOMETER

Distance in kilometers (1000 meters).

SECOND

Duration in seconds (SI base unit of time).

MINUTE

Duration in minutes (60 seconds).

HOUR

Duration in hours (3600 seconds).

CALORIE

Energy in small calories (cal). Note: dietary "Calories" are KILOCALORIE.

KILOCALORIE

Energy in kilocalories (kcal) — the unit shown on nutrition labels as "Calories".

STEP

A raw step count (dimensionless).

POUND

Mass in pounds (~0.4536 kilograms). Common for US members.

OUNCE

Mass in ounces (1/16 of a POUND).

DEGREE_CELSIUS

Temperature in degrees Celsius.

DEGREE_FAHRENHEIT

Temperature in degrees Fahrenheit.

KILOGRAM

Mass in kilograms (SI base unit of mass).

PERCENTAGE

A ratio expressed as a percentage in the range 0–100.

Properties

entries

val entries: EnumEntries<UnitTypes>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): UnitTypes

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<UnitTypes>

Returns an array containing the constants of this enum type, in the order they're declared.