# BasalBodyTemperatureRecord

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/records/BasalBodyTemperatureRecord.kt+class:androidx.health.connect.client.records.BasalBodyTemperatureRecord) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
class BasalBodyTemperatureRecord : Record
```

<br />

*** ** * ** ***

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 |
|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#BasalBodyTemperatureRecord(java.time.Instant,java.time.ZoneOffset,androidx.health.connect.client.records.metadata.Metadata,androidx.health.connect.client.units.Temperature,kotlin.Int)( time: https://developer.android.com/reference/java/time/Instant.html, zoneOffset: https://developer.android.com/reference/java/time/ZoneOffset.html?, metadata: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata, temperature: https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Temperature, measurementLocation: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#measurementLocation()` Where on the user's basal body the temperature measurement was taken from. |
| `open https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#metadata()` Set of common metadata associated with the written record. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Temperature` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#temperature()` Temperature in `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Temperature` unit. |
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#time()` Time the record happened. |
| `open https://developer.android.com/reference/java/time/ZoneOffset.html?` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalBodyTemperatureRecord#zoneOffset()` User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#time()`, or null if unknown. |

## Public constructors

### BasalBodyTemperatureRecord

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
BasalBodyTemperatureRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    metadata: Metadata,
    temperature: Temperature,
    measurementLocation: Int = BodyTemperatureMeasurementLocation.MEASUREMENT_LOCATION_UNKNOWN
)
```

## 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](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val measurementLocation: Int
```

Where on the user's basal body the temperature measurement was taken from. Optional field. Allowed values: `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BodyTemperatureMeasurementLocation`.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`
- `6`
- `7`
- `8`
- `9`
- `10`

<br />

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BodyTemperatureMeasurementLocation` |   |

### metadata

```
open val metadata: Metadata
```

Set of common metadata associated with the written record.

### temperature

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val temperature: Temperature
```

Temperature in `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Temperature` unit. Required field. Valid range: 0-100 Celsius degrees.

### time

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val time: Instant
```

Time the record happened.

### zoneOffset

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open val zoneOffset: ZoneOffset?
```

User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#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.