ExerciseState

enum ExerciseState


Enumerates the state of an exercise.

Summary

Enum Values

ACTIVE

The exercise is actively in-progress.

AUTO_ENDED

The exercise has been automatically ended due to a lack of exercise updates being received by the user.

AUTO_ENDED_PERMISSION_LOST

The exercise has been automatically ended due to lack of client's permissions to receive data for the exercise.

AUTO_ENDING

The exercise is being automatically ended due to a lack of exercise updates being received by the user.

AUTO_ENDING_PERMISSION_LOST

The exercise is being automatically ended due to lack of client's permissions to receive data for the exercise.

AUTO_PAUSED

The session has been automatically paused.

AUTO_PAUSING

The session is being paused by auto-pause.

AUTO_RESUMING

The session is being automatically resumed.

PREPARING

The exercise is being prepared, GPS and HeartRate sensors will be turned on if requested in the WarmUpConfig.

TERMINATED

The exercise has been ended because it was superseded by a new exercise being started by another client.

TERMINATING

The exercise is being ended because it has been superseded by a new exercise being started by another client.

USER_ENDED

The exercise has been ended by the user.

USER_ENDING

The exercise is being ended by the user.

USER_PAUSED

The session has been paused by the user.

USER_PAUSING

The session is being paused by the user.

USER_RESUMING

The session is being resumed by the user.

USER_STARTING

The exercise is actively being started, but we don't yet have sensor stability or GPS fix.

Public fields

final int
final boolean

Returns true if this ExerciseState corresponds to one of the ended states and false otherwise.

final boolean

Returns true if this ExerciseState corresponds to one of the ending states and false otherwise.

final boolean

Returns true if this ExerciseState corresponds to one of the paused states and false otherwise.

final boolean

Returns true if this ExerciseState corresponds to one of the resuming states and false otherwise.

Enum Values

ACTIVE

ExerciseState ExerciseState.ACTIVE

The exercise is actively in-progress.

Used in both of the manually started exercise and the automatic exercise detection. It's also the state when the automatic exercise detection has detected an exercise and the exercise is actively in-progress.

AUTO_ENDED

ExerciseState ExerciseState.AUTO_ENDED

The exercise has been automatically ended due to a lack of exercise updates being received by the user. No new metrics will be exported and a final summary should be provided to the client.

Used only in the manually started exercise.

AUTO_ENDED_PERMISSION_LOST

ExerciseState ExerciseState.AUTO_ENDED_PERMISSION_LOST

The exercise has been automatically ended due to lack of client's permissions to receive data for the exercise.

AUTO_ENDING