PlannedExerciseStep

Artifact: androidx.health.connect:connect-client

Added in 1.1.0

Kotlin |Java

public final class PlannedExerciseStep

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

Summary

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

Public constructors
`PlannedExerciseStep( int exerciseType, int exercisePhase, @NonNull ExerciseCompletionGoal completionGoal, @NonNull List<@NonNull ExercisePerformanceTarget> performanceTargets, String description )`

Public methods
`boolean`	`equals(Object other)`
`final @NonNull ExerciseCompletionGoal`	`getCompletionGoal()` The goal that must be completed to finish this step.
`final String`	`getDescription()` The description of this step.
`final int`	`getExercisePhase()` The phase e.g. 'warmup' that this step belongs to.
`final int`	`getExerciseType()` The type of exercise that this step involves.
`final @NonNull List<@NonNull ExercisePerformanceTarget>`	`getPerformanceTargets()` Performance related targets that should be met during this step.
`int`	`hashCode()`
`@NonNull String`	`toString()`

Constants

EXERCISE_PHASE_ACTIVE

public static final int EXERCISE_PHASE_ACTIVE = 3

Active exercise.

EXERCISE_PHASE_COOLDOWN

public static final int EXERCISE_PHASE_COOLDOWN = 4

Cooldown exercise, typically at the end of a workout.

EXERCISE_PHASE_RECOVERY

public static final int EXERCISE_PHASE_RECOVERY = 5

Lower intensity, active exercise.

EXERCISE_PHASE_REST

public static final int EXERCISE_PHASE_REST = 2

A rest.

EXERCISE_PHASE_UNKNOWN

public static final int EXERCISE_PHASE_UNKNOWN = 0

An unknown phase of exercise.

EXERCISE_PHASE_WARMUP

public static final int EXERCISE_PHASE_WARMUP = 1

A warmup.

Public constructors

PlannedExerciseStep

public PlannedExerciseStep(
    int exerciseType,
    int exercisePhase,
    @NonNull ExerciseCompletionGoal completionGoal,
    @NonNull List<@NonNull ExercisePerformanceTarget> performanceTargets,
    String description
)

Parameters
`int exerciseType`	The type of exercise that this step involves.
`int exercisePhase`	The phase e.g. 'warmup' that this step belongs to.
`@NonNull ExerciseCompletionGoal completionGoal`	The goal that must be completed to finish this step.
`@NonNull List<@NonNull ExercisePerformanceTarget> performanceTargets`	Performance related targets that should be met during this step.
`String description`	The description of this step.

Public methods

equals

public boolean equals(Object other)

getCompletionGoal

Added in 1.1.0

public final @NonNull ExerciseCompletionGoal getCompletionGoal()

The goal that must be completed to finish this step.

getDescription

Added in 1.1.0

public final String getDescription()

The description of this step.

getExercisePhase

Added in 1.1.0

public final int getExercisePhase()

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

getExerciseType

Added in 1.1.0

public final int getExerciseType()

The type of exercise that this step involves.

getPerformanceTargets

Added in 1.1.0

public final @NonNull List<@NonNull ExercisePerformanceTarget> getPerformanceTargets()

Performance related targets that should be met during this step.

hashCode

public int hashCode()

toString

public @NonNull String toString()