# StepsCadenceRecord

# StepsCadenceRecord

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

<br />

```
class StepsCadenceRecord : Record
```

<br />

*** ** * ** ***

Captures the user's steps cadence. Each record represents a series of measurements.

## Summary

|                                                                                              ### Nested types                                                                                              |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[StepsCadenceRecord.Sample](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord.Sample) Represents a single measurement of the steps cadence. |

|                                                                                          ### Public companion properties                                                                                          |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [AggregateMetric](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric)`<`[Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)`>` | [RATE_AVG](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#RATE_AVG()) Metric identifier to retrieve average steps cadence from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult). |
| [AggregateMetric](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric)`<`[Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)`>` | [RATE_MAX](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#RATE_MAX()) Metric identifier to retrieve maximum steps cadence from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult). |
| [AggregateMetric](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregateMetric)`<`[Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)`>` | [RATE_MIN](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#RATE_MIN()) Metric identifier to retrieve minimum steps cadence from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult). |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               ### Public constructors                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [StepsCadenceRecord](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#StepsCadenceRecord(java.time.Instant,java.time.ZoneOffset,java.time.Instant,java.time.ZoneOffset,kotlin.collections.List,androidx.health.connect.client.records.metadata.Metadata))`(` ` startTime: `[Instant](https://developer.android.com/reference/java/time/Instant.html)`,` ` startZoneOffset: `[ZoneOffset](https://developer.android.com/reference/java/time/ZoneOffset.html)`?,` ` endTime: `[Instant](https://developer.android.com/reference/java/time/Instant.html)`,` ` endZoneOffset: `[ZoneOffset](https://developer.android.com/reference/java/time/ZoneOffset.html)`?,` ` samples: `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[StepsCadenceRecord.Sample](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord.Sample)`>,` ` 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/StepsCadenceRecord#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/StepsCadenceRecord#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/StepsCadenceRecord#toString())`()`                                                                                            |

|                                                                                                               ### Public properties                                                                                                                |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `open `[Instant](https://developer.android.com/reference/java/time/Instant.html)                                                                                                                                                                   | [endTime](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#endTime()) End time of the record.                                                                                                                                                                               |
| `open `[ZoneOffset](https://developer.android.com/reference/java/time/ZoneOffset.html)`?`                                                                                                                                                          | [endZoneOffset](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#endZoneOffset()) User experienced zone offset at[endTime](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#endTime()), or null if unknown.         |
| `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/StepsCadenceRecord#metadata()) Set of common metadata associated with the written record.                                                                                                                                          |
| `open `[List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)`<`[StepsCadenceRecord.Sample](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord.Sample)`>` | [samples](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#samples())                                                                                                                                                                                                       |
| `open `[Instant](https://developer.android.com/reference/java/time/Instant.html)                                                                                                                                                                   | [startTime](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#startTime()) Start time of the record.                                                                                                                                                                         |
| `open `[ZoneOffset](https://developer.android.com/reference/java/time/ZoneOffset.html)`?`                                                                                                                                                          | [startZoneOffset](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#startZoneOffset()) User experienced zone offset at[startTime](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#startTime()), or null if unknown. |

## Public companion properties

### RATE_AVG

```
val RATE_AVG: AggregateMetric<Double>
```

Metric identifier to retrieve average steps cadence from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult).  

### RATE_MAX

```
val RATE_MAX: AggregateMetric<Double>
```

Metric identifier to retrieve maximum steps cadence from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult).  

### RATE_MIN

```
val RATE_MIN: AggregateMetric<Double>
```

Metric identifier to retrieve minimum steps cadence from[androidx.health.connect.client.aggregate.AggregationResult](https://developer.android.com/reference/kotlin/androidx/health/connect/client/aggregate/AggregationResult).  

## Public constructors

### StepsCadenceRecord

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

```
StepsCadenceRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    samples: List<StepsCadenceRecord.Sample>,
    metadata: Metadata
)
```  

## Public functions

### equals

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

### hashCode

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

### toString

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

## Public properties

### endTime

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

```
open val endTime: Instant
```

End time of the record.  

### endZoneOffset

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

```
open val endZoneOffset: ZoneOffset?
```

User experienced zone offset at[endTime](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#endTime()), 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.  

### metadata

```
open val metadata: Metadata
```

Set of common metadata associated with the written record.  

### samples

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

```
open val samples: List<StepsCadenceRecord.Sample>
```  

### startTime

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

```
open val startTime: Instant
```

Start time of the record.  

### startZoneOffset

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

```
open val startZoneOffset: ZoneOffset?
```

User experienced zone offset at[startTime](https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/StepsCadenceRecord#startTime()), 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.