BasalBodyTemperatureRecord

public final class BasalBodyTemperatureRecord implements 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(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    @NonNull Temperature temperature,
    int measurementLocation,
    @NonNull Metadata metadata
)

Public methods

boolean
equals(Object other)
final int

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

@NonNull Metadata

Set of common metadata associated with the written record.

final @NonNull Temperature

Temperature in Temperature unit.

@NonNull Instant

Time the record happened.

ZoneOffset

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

int

Public constructors

BasalBodyTemperatureRecord

Added in 1.1.0-alpha07
public BasalBodyTemperatureRecord(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    @NonNull Temperature temperature,
    int measurementLocation,
    @NonNull Metadata metadata
)

Public methods

equals

public boolean equals(Object other)

getMeasurementLocation

Added in 1.1.0-alpha07
public final int getMeasurementLocation()

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

getMetadata

Added in 1.1.0-alpha07
public @NonNull Metadata getMetadata()

Set of common metadata associated with the written record.

getTemperature

Added in 1.1.0-alpha07
public final @NonNull Temperature getTemperature()

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

getTime

Added in 1.1.0-alpha07
public @NonNull Instant getTime()

Time the record happened.

getZoneOffset

Added in 1.1.0-alpha07
public ZoneOffset getZoneOffset()

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.

hashCode

public int hashCode()