BasalBodyTemperatureRecord

class BasalBodyTemperatureRecord : Record

Captures the body temperature of a user when at rest (for example, immediately after waking up). Can be used for checking the fertility window. Each data point represents a single instantaneous body temperature measurement.

Summary

Public constructors
BasalBodyTemperatureRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    temperature: Temperature,
    measurementLocation: Int,
    metadata: Metadata
)

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

Public properties
Int

Where on the user's basal body the temperature measurement was taken from.
open Metadata

Set of common metadata associated with the written record.
Temperature

Temperature in Temperature unit.
open Instant

Time the record happened.
open ZoneOffset?

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

Public constructors

BasalBodyTemperatureRecord

Added in 1.1.0-alpha10
BasalBodyTemperatureRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    temperature: Temperature,
    measurementLocation: Int = BodyTemperatureMeasurementLocation.MEASUREMENT_LOCATION_UNKNOWN,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

measurementLocation

Added in 1.1.0-alpha10
val measurementLocation: Int

Where on the user's basal body the temperature measurement was taken from. Optional field. Allowed values: BodyTemperatureMeasurementLocation.

See also
BodyTemperatureMeasurementLocation

metadata

Added in 1.1.0-alpha10
open val metadata: Metadata

Set of common metadata associated with the written record.

temperature

Added in 1.1.0-alpha10
val temperature: Temperature

Temperature in Temperature unit. Required field. Valid range: 0-100 Celsius degrees.

time

Added in 1.1.0-alpha10
open val time: Instant

Time the record happened.

zoneOffset

Added in 1.1.0-alpha10
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.