class HeartRateRecord : Record


Captures the user's heart rate. Each record represents a series of measurements.

Summary

Nested types

Represents a single measurement of the heart rate.

Public companion properties

AggregateMetric<Long>

Metric identifier to retrieve the average heart rate from AggregationResult.

AggregateMetric<Long>

Metric identifier to retrieve the maximum heart rate from AggregationResult.

AggregateMetric<Long>

Metric identifier to retrieve the minimum heart rate from AggregationResult.

AggregateMetric<Long>

Metric identifier to retrieve the number of heart rate measurements from AggregationResult.

Public constructors

HeartRateRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    samples: List<HeartRateRecord.Sample>,
    metadata: Metadata
)

Public functions

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

Public properties

open Instant

End time of the record.

open ZoneOffset?

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

open Metadata

Set of common metadata associated with the written record.

open List<HeartRateRecord.Sample>
open Instant

Start time of the record.

open ZoneOffset?

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

Public companion properties

BPM_AVG

val BPM_AVGAggregateMetric<Long>

Metric identifier to retrieve the average heart rate from AggregationResult.

BPM_MAX

val BPM_MAXAggregateMetric<Long>

Metric identifier to retrieve the maximum heart rate from AggregationResult.

BPM_MIN

val BPM_MINAggregateMetric<Long>

Metric identifier to retrieve the minimum heart rate from AggregationResult.

MEASUREMENTS_COUNT

val MEASUREMENTS_COUNTAggregateMetric<Long>

Metric identifier to retrieve the number of heart rate measurements from AggregationResult.

Public constructors

HeartRateRecord

Added in 1.1.0-alpha07
HeartRateRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    samples: List<HeartRateRecord.Sample>,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

Public properties

endTime

Added in 1.1.0-alpha07
open val endTimeInstant

End time of the record.

endZoneOffset

Added in 1.1.0-alpha07
open val endZoneOffsetZoneOffset?

User experienced zone offset at endTime, 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.

metadata

Added in 1.1.0-alpha07
open val metadataMetadata

Set of common metadata associated with the written record.

samples

Added in 1.1.0-alpha07
open val samplesList<HeartRateRecord.Sample>

startTime

Added in 1.1.0-alpha07
open val startTimeInstant

Start time of the record.

startZoneOffset

Added in 1.1.0-alpha07
open val startZoneOffsetZoneOffset?

User experienced zone offset at startTime, 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.