# RestingHeartRateRecord

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/RestingHeartRateRecord.kt+class:androidx.health.connect.client.records.RestingHeartRateRecord) 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/RestingHeartRateRecord "View this page in Java")


```
class RestingHeartRateRecord : Record
```

<br />

*** ** * ** ***

Captures the user's resting heart rate. Each record represents a single instantaneous measurement.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#BPM_AVG()` Metric identifier to retrieve the average resting heart rate from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#BPM_MAX()` Metric identifier to retrieve the maximum resting heart rate from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#BPM_MIN()` Metric identifier to retrieve the minimum resting heart rate from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#RestingHeartRateRecord(java.time.Instant,java.time.ZoneOffset,kotlin.Long,androidx.health.connect.client.records.metadata.Metadata)( time: https://developer.android.com/reference/java/time/Instant.html, zoneOffset: https://developer.android.com/reference/java/time/ZoneOffset.html?, beatsPerMinute: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, metadata: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/metadata/Metadata )` |

| ### 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/RestingHeartRateRecord#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/RestingHeartRateRecord#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#beatsPerMinute()` Heart beats per minute. |
| `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/RestingHeartRateRecord#metadata()` Set of common metadata associated with the written record. |
| `open https://developer.android.com/reference/java/time/Instant.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/RestingHeartRateRecord#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/RestingHeartRateRecord#zoneOffset()` User experienced zone offset at `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/InstantaneousRecord#time()`, or null if unknown. |

## Public companion properties

### BPM_AVG

```
val BPM_AVG: AggregateMetric<Long>
```

Metric identifier to retrieve the average resting heart rate from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### BPM_MAX

```
val BPM_MAX: AggregateMetric<Long>
```

Metric identifier to retrieve the maximum resting heart rate from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

### BPM_MIN

```
val BPM_MIN: AggregateMetric<Long>
```

Metric identifier to retrieve the minimum resting heart rate from `https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult`.

## Public constructors

### RestingHeartRateRecord

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

```
RestingHeartRateRecord(
    time: Instant,
    zoneOffset: ZoneOffset?,
    beatsPerMinute: Long,
    metadata: Metadata
)
```

## Public functions

### equals

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

### hashCode

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

### toString

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

## Public properties

### beatsPerMinute

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

```
val beatsPerMinute: Long
```

Heart beats per minute. Required field. Validation range: 1-300.

### 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 `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.