# PlannedExerciseStep

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

*** ** * ** ***


```
class PlannedExerciseStep
```

<br />

*** ** * ** ***

A single step within an `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseBlock` e.g. 8x 60kg barbell squats.

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_ACTIVE() = 3` Active exercise. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_COOLDOWN() = 4` Cooldown exercise, typically at the end of a workout. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_RECOVERY() = 5` Lower intensity, active exercise. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_REST() = 2` A rest. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_UNKNOWN() = 0` An unknown phase of exercise. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#EXERCISE_PHASE_WARMUP() = 1` A warmup. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#PlannedExerciseStep(kotlin.Int,kotlin.Int,androidx.health.connect.client.records.ExerciseCompletionGoal,kotlin.collections.List,kotlin.String)( exerciseType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, exercisePhase: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, completionGoal: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/ExerciseCompletionGoal, performanceTargets: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/ExercisePerformanceTarget>, description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/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/PlannedExerciseStep#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/PlannedExerciseStep#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#toString()()` |

| ### Public properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/ExerciseCompletionGoal` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#completionGoal()` The goal that must be completed to finish this step. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#description()` The description of this step. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#exercisePhase()` The phase e.g. 'warmup' that this step belongs to. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#exerciseType()` The type of exercise that this step involves. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/ExercisePerformanceTarget>` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/PlannedExerciseStep#performanceTargets()` Performance related targets that should be met during this step. |

## Constants

### EXERCISE_PHASE_ACTIVE

```
const val EXERCISE_PHASE_ACTIVE = 3: Int
```

Active exercise.

### EXERCISE_PHASE_COOLDOWN

```
const val EXERCISE_PHASE_COOLDOWN = 4: Int
```

Cooldown exercise, typically at the end of a workout.

### EXERCISE_PHASE_RECOVERY

```
const val EXERCISE_PHASE_RECOVERY = 5: Int
```

Lower intensity, active exercise.

### EXERCISE_PHASE_REST

```
const val EXERCISE_PHASE_REST = 2: Int
```

A rest.

### EXERCISE_PHASE_UNKNOWN

```
const val EXERCISE_PHASE_UNKNOWN = 0: Int
```

An unknown phase of exercise.

### EXERCISE_PHASE_WARMUP

```
const val EXERCISE_PHASE_WARMUP = 1: Int
```

A warmup.

## Public constructors

### PlannedExerciseStep

```
PlannedExerciseStep(
    exerciseType: Int,
    exercisePhase: Int,
    completionGoal: ExerciseCompletionGoal,
    performanceTargets: List<ExercisePerformanceTarget>,
    description: String? = null
)
```

| Parameters |
|---|---|
| `exerciseType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The type of exercise that this step involves. |
| `exercisePhase: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The phase e.g. 'warmup' that this step belongs to. |
| `completionGoal: https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/ExerciseCompletionGoal` | The goal that must be completed to finish this step. |
| `performanceTargets: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/health/connect/client/records/ExercisePerformanceTarget>` | Performance related targets that should be met during this step. |
| `description: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html? = null` | The description of this step. |

## Public functions

### equals

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

### hashCode

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

### toString

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

## Public properties

### completionGoal

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

```
val completionGoal: ExerciseCompletionGoal
```

The goal that must be completed to finish this step.

### description

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

```
val description: String?
```

The description of this step.

### exercisePhase

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

```
val exercisePhase: Int
```

The phase e.g. 'warmup' that this step belongs to.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`

<br />

### exerciseType

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

```
val exerciseType: Int
```

The type of exercise that this step involves.

Value is one of the following:

- `0`
- `4`
- `6`
- `7`
- `8`
- `13`
- `14`
- `15`
- `16`
- `18`
- `19`
- `20`
- `22`
- `21`
- `24`
- `40`
- `45`
- `46`
- `47`
- `52`
- `53`
- `54`
- `60`
- `62`
- `63`
- `64`
- `65`
- `66`
- `38`
- `67`
- `1`
- `2`
- `3`
- `5`
- `9`
- `10`
- `11`
- `12`
- `17`
- `23`
- `25`
- `26`
- `27`
- `28`
- `29`
- `30`
- `31`
- `32`
- `33`
- `34`
- `35`
- `36`
- `37`
- `41`
- `42`
- `43`
- `48`
- `49`
- `50`
- `51`
- `58`
- `55`
- `56`
- `57`
- `59`
- `61`
- `44`
- `39`

<br />

### performanceTargets

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

```
val performanceTargets: List<ExercisePerformanceTarget>
```

Performance related targets that should be met during this step.