PlannedExerciseStep

Artifact: androidx.health.connect:connect-client

View Source

Added in 1.1.0-alpha10

---

Kotlin |Java

class PlannedExerciseStep

---

A single step within an PlannedExerciseBlock e.g. 8x 60kg barbell squats.

Summary

Constants
const Int	EXERCISE_PHASE_ACTIVE = 3 Active exercise.
const Int	EXERCISE_PHASE_COOLDOWN = 4 Cooldown exercise, typically at the end of a workout.
const Int	EXERCISE_PHASE_RECOVERY = 5 Lower intensity, active exercise.
const Int	EXERCISE_PHASE_REST = 2 A rest.
const Int	EXERCISE_PHASE_UNKNOWN = 0 An unknown phase of exercise.
const Int	EXERCISE_PHASE_WARMUP = 1 A warmup.

Public constructors
PlannedExerciseStep(     exerciseType: Int,     exercisePhase: Int,     completionGoal: ExerciseCompletionGoal,     performanceTargets: List<ExercisePerformanceTarget>,     description: String? )

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
ExerciseCompletionGoal	completionGoal The goal that must be completed to finish this step.
String?	description The description of this step.
Int	exercisePhase The phase e.g. 'warmup' that this step belongs to.
Int	exerciseType The type of exercise that this step involves.
List<ExercisePerformanceTarget>	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: Int	The type of exercise that this step involves.
exercisePhase: Int	The phase e.g. 'warmup' that this step belongs to.
completionGoal: ExerciseCompletionGoal	The goal that must be completed to finish this step.
performanceTargets: List<ExercisePerformanceTarget>	Performance related targets that should be met during this step.
description: String? = 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-alpha10

val completionGoal: ExerciseCompletionGoal

The goal that must be completed to finish this step.

description

Added in 1.1.0-alpha10

val description: String?

The description of this step.

exercisePhase

Added in 1.1.0-alpha10

val exercisePhase: Int

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

exerciseType

Added in 1.1.0-alpha10

val exerciseType: Int

The type of exercise that this step involves.

performanceTargets

Added in 1.1.0-alpha10

val performanceTargets: List<ExercisePerformanceTarget>

Performance related targets that should be met during this step.