HeightRecord

Artifact: androidx.health.connect:connect-client

Added in 1.1.0

Kotlin |Java

class HeightRecord : Record

Captures the user's height.

Summary

Public companion properties
`AggregateMetric<Length>`	`HEIGHT_AVG` Metric identifier to retrieve the average height from `androidx.health.connect.client.aggregate.AggregationResult`.
`AggregateMetric<Length>`	`HEIGHT_MAX` Metric identifier to retrieve the maximum height from `androidx.health.connect.client.aggregate.AggregationResult`.
`AggregateMetric<Length>`	`HEIGHT_MIN` Metric identifier to retrieve minimum height from `androidx.health.connect.client.aggregate.AggregationResult`.

Public constructors
`HeightRecord( time: Instant, zoneOffset: ZoneOffset?, height: Length, metadata: Metadata )`

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`Length`	`height` Height in `Length` unit.
`open Metadata`	`metadata` Set of common metadata associated with the written record.
`open Instant`	`time` Time the record happened.
`open ZoneOffset?`	`zoneOffset` User experienced zone offset at `time`, or null if unknown.

Public companion properties

HEIGHT_AVG

val HEIGHT_AVG: AggregateMetric<Length>

Metric identifier to retrieve the average height from androidx.health.connect.client.aggregate.AggregationResult.

HEIGHT_MAX

val HEIGHT_MAX: AggregateMetric<Length>

Metric identifier to retrieve the maximum height from androidx.health.connect.client.aggregate.AggregationResult.

HEIGHT_MIN

val HEIGHT_MIN: AggregateMetric<Length>

Metric identifier to retrieve minimum height from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

HeightRecord

Added in 1.1.0

HeightRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    height: Length,
    metadata: Metadata
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

height

Added in 1.1.0

val height: Length

Height in Length unit. Required field. Valid range: 0-3 meters.

metadata

open val metadata: Metadata

Set of common metadata associated with the written record.

time

Added in 1.1.0

open val time: Instant

Time the record happened.

zoneOffset

Added in 1.1.0

open val zoneOffset: ZoneOffset?

User experienced zone offset at time, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.