WeightRecord

Artifact: androidx.health.connect:connect-client

Added in 1.1.0

Kotlin |Java

class WeightRecord : Record

Captures the user's weight.

See Mass for supported units.

Summary

Public companion properties
`AggregateMetric<Mass>`	`WEIGHT_AVG` Metric identifier to retrieve the average weight from `androidx.health.connect.client.aggregate.AggregationResult`.
`AggregateMetric<Mass>`	`WEIGHT_MAX` Metric identifier to retrieve the maximum weight from `androidx.health.connect.client.aggregate.AggregationResult`.
`AggregateMetric<Mass>`	`WEIGHT_MIN` Metric identifier to retrieve the minimum weight from `androidx.health.connect.client.aggregate.AggregationResult`.

Public constructors
`WeightRecord( time: Instant, zoneOffset: ZoneOffset?, weight: Mass, metadata: Metadata )`

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

Public properties
`open Metadata`	`metadata` Set of common metadata associated with the written record.
`open Instant`	`time` Time the record happened.
`Mass`	`weight` User's weight in kilograms.
`open ZoneOffset?`	`zoneOffset` User experienced zone offset at `time`, or null if unknown.

Public companion properties

WEIGHT_AVG

val WEIGHT_AVG: AggregateMetric<Mass>

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

WEIGHT_MAX

val WEIGHT_MAX: AggregateMetric<Mass>

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

WEIGHT_MIN

val WEIGHT_MIN: AggregateMetric<Mass>

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

Public constructors

WeightRecord

Added in 1.1.0

WeightRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    weight: Mass,
    metadata: Metadata
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

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.

weight

Added in 1.1.0

val weight: Mass

User's weight in kilograms. Required field. Valid range: 0-1000 kilograms.

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.