RestingHeartRateRecord

class RestingHeartRateRecord : Record


Captures the user's resting heart rate. Each record represents a single instantaneous measurement.

Summary

Public companion properties

AggregateMetric<Long>

Metric identifier to retrieve the average resting heart rate from AggregationResult.

AggregateMetric<Long>

Metric identifier to retrieve the maximum resting heart rate from AggregationResult.

AggregateMetric<Long>

Metric identifier to retrieve the minimum resting heart rate from AggregationResult.

Public constructors

RestingHeartRateRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    beatsPerMinute: Long,
    metadata: Metadata
)

Public functions

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

Public properties

Long

Heart beats per minute.

open Metadata

Set of common metadata associated with the written record.

open Instant

Time the record happened.

open ZoneOffset?

User experienced zone offset at time, or null if unknown.

Public companion properties

BPM_AVG

val BPM_AVGAggregateMetric<Long>

Metric identifier to retrieve the average resting heart rate from AggregationResult.

BPM_MAX

val BPM_MAXAggregateMetric<Long>

Metric identifier to retrieve the maximum resting heart rate from AggregationResult.

BPM_MIN

val BPM_MINAggregateMetric<Long>

Metric identifier to retrieve the minimum resting heart rate from AggregationResult.

Public constructors

RestingHeartRateRecord

Added in 1.1.0-alpha07
RestingHeartRateRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    beatsPerMinute: Long,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

Public properties

beatsPerMinute

Added in 1.1.0-alpha07
val beatsPerMinuteLong

Heart beats per minute. Required field. Validation range: 1-300.

metadata

Added in 1.1.0-alpha07
open val metadataMetadata

Set of common metadata associated with the written record.

time

Added in 1.1.0-alpha07
open val timeInstant

Time the record happened.

zoneOffset

Added in 1.1.0-alpha07
open val zoneOffsetZoneOffset?

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.