# BasalMetabolicRateRecord

# BasalMetabolicRateRecord

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/BasalMetabolicRateRecord.kt+class:androidx.health.connect.client.records.BasalMetabolicRateRecord)  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/health/connect/client/records/BasalMetabolicRateRecord "View this page in Java")

<br />

```
class BasalMetabolicRateRecord : Record
```

<br />

*** ** * ** ***

Captures the BMR of a user. Each record represents the energy a user would burn if at rest all day, based on their height and weight.

## Summary

|                                                                                                   ### Public companion properties                                                                                                    |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [AggregateMetric](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric)`<`[Energy](https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Energy)`>` | [BASAL_CALORIES_TOTAL](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#BASAL_CALORIES_TOTAL()) Metric identifier to retrieve the total basal calories burned from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult). |

|                                                                                                                                                                                                                                                                                                                                                                            ### Public constructors                                                                                                                                                                                                                                                                                                                                                                            |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [BasalMetabolicRateRecord](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#BasalMetabolicRateRecord(java.time.Instant,java.time.ZoneOffset,androidx.health.connect.client.units.Power,androidx.health.connect.client.records.metadata.Metadata))`(` ` time: `[Instant](https://developer.android.com/reference/java/time/Instant.html)`,` ` zoneOffset: `[ZoneOffset](https://developer.android.com/reference/java/time/ZoneOffset.html)`?,` ` basalMetabolicRate: `[Power](https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Power)`,` ` metadata: `[Metadata](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata) `)` |

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

|                                                   ### Public properties                                                    |
|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Power](https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Power)                         | [basalMetabolicRate](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#basalMetabolicRate()) Basal metabolic rate, in[Power](https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Power)unit.                                   |
| `open `[Metadata](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata) | [metadata](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#metadata()) Set of common metadata associated with the written record.                                                                                                                            |
| `open `[Instant](https://developer.android.com/reference/java/time/Instant.html)                                           | [time](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#time()) Time the record happened.                                                                                                                                                                     |
| `open `[ZoneOffset](https://developer.android.com/reference/java/time/ZoneOffset.html)`?`                                  | [zoneOffset](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#zoneOffset()) User experienced zone offset at[time](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#time()), or null if unknown. |

## Public companion properties

### BASAL_CALORIES_TOTAL

```
val BASAL_CALORIES_TOTAL: AggregateMetric<Energy>
```

Metric identifier to retrieve the total basal calories burned from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult).  

## Public constructors

### BasalMetabolicRateRecord

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

```
BasalMetabolicRateRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    basalMetabolicRate: Power,
    metadata: Metadata
)
```  

## Public functions

### equals

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

### hashCode

```
open fun hashCode(): Int
```  

### toString

```
open fun toString(): String
```  

## Public properties

### basalMetabolicRate

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

```
val basalMetabolicRate: Power
```

Basal metabolic rate, in[Power](https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Power)unit. Required field. Valid range: 0-10000 kcal/day.  

### metadata

```
open val metadata: Metadata
```

Set of common metadata associated with the written record.  

### 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[time](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/BasalMetabolicRateRecord#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.