ExerciseConfig
public final class ExerciseConfig
Defines configuration for an exercise tracked using Health Services.
Summary
Nested types |
|---|
public final class ExerciseConfig.BuilderBuilder for |
Constants |
|
|---|---|
static final float |
Public constructors |
|---|
ExerciseConfig(Creates a new ExerciseConfig for an exercise tracked using Health Services |
Public methods |
|
|---|---|
static final @NonNull ExerciseConfig.Builder |
builder(@NonNull ExerciseType exerciseType)Returns a fresh new |
final @NonNull Set<@NonNull BatchingMode> |
|
final @NonNull Set<@NonNull DataType<@NonNull ?, @NonNull ?>> |
|
final @NonNull List<@NonNull DebouncedGoal<@NonNull ?>> |
|
final @NonNull Set<@NonNull ExerciseEventType<@NonNull ?>> |
|
final @NonNull List<@NonNull ExerciseGoal<@NonNull ?>> |
|
final @NonNull Bundle |
|
final @NonNull ExerciseType |
|
final ExerciseTypeConfig |
|
final float |
length (in meters) of the swimming pool, or 0 if not relevant to this exercise |
final boolean |
whether auto-pause/resume is enabled for this exercise |
final boolean |
whether GPS is enabled for this exercise. |
@NonNull String |
toString() |
Constants
Public constructors
ExerciseConfig
public ExerciseConfig(
@NonNull ExerciseType exerciseType,
@NonNull Set<@NonNull DataType<@NonNull ?, @NonNull ?>> dataTypes,
boolean isAutoPauseAndResumeEnabled,
boolean isGpsEnabled,
@NonNull List<@NonNull ExerciseGoal<@NonNull ?>> exerciseGoals,
@NonNull Bundle exerciseParams,
@FloatRange(from = 0.0) float swimmingPoolLengthMeters,
ExerciseTypeConfig exerciseTypeConfig,
@NonNull Set<@NonNull BatchingMode> batchingModeOverrides,
@NonNull Set<@NonNull ExerciseEventType<@NonNull ?>> exerciseEventTypes,
@NonNull List<@NonNull DebouncedGoal<@NonNull ?>> debouncedGoals
)
Creates a new ExerciseConfig for an exercise tracked using Health Services
Public methods
builder
public static final @NonNull ExerciseConfig.Builder builder(@NonNull ExerciseType exerciseType)
Returns a fresh new Builder.
| Parameters | |
|---|---|
@NonNull ExerciseType exerciseType |
the |
getBatchingModeOverrides
public final @NonNull Set<@NonNull BatchingMode> getBatchingModeOverrides()
BatchingMode overrides for this exercise
getDataTypes
public final @NonNull Set<@NonNull DataType<@NonNull ?, @NonNull ?>> getDataTypes()
DataType which will be tracked for this exercise
getDebouncedGoals
public final @NonNull List<@NonNull DebouncedGoal<@NonNull ?>> getDebouncedGoals()
DebouncedGoals for this exercise. DataTypes in DebouncedGoals must also be tracked.
getExerciseEventTypes
public final @NonNull Set<@NonNull ExerciseEventType<@NonNull ?>> getExerciseEventTypes()
ExerciseEventTypes which should be tracked for this exercise
getExerciseGoals
public final @NonNull List<@NonNull ExerciseGoal<@NonNull ?>> getExerciseGoals()
ExerciseGoals for this exercise. DataTypes in ExerciseGoals must also be tracked (i.e. contained in dataTypes) in some form. For example, an ExerciseGoal for DataType.STEPS_TOTAL requires that dataTypes contains either or both of DataType.STEPS_TOTAL / DataType.STEPS.
getExerciseParams
public final @NonNull Bundle getExerciseParams()
Bundle bundle for specifying exercise presets, the values of an on-going exercise which can be used to pre-populate a new exercise.
getExerciseType
public final @NonNull ExerciseType getExerciseType()
ExerciseType user is performing for this exercise
getExerciseTypeConfig
public final ExerciseTypeConfig getExerciseTypeConfig()
ExerciseTypeConfig containing attributes which may be modified after the exercise has started
getSwimmingPoolLengthMeters
public final float getSwimmingPoolLengthMeters()
length (in meters) of the swimming pool, or 0 if not relevant to this exercise
isAutoPauseAndResumeEnabled
public final boolean isAutoPauseAndResumeEnabled()
whether auto-pause/resume is enabled for this exercise
isGpsEnabled
public final boolean isGpsEnabled()
whether GPS is enabled for this exercise. Must be set to true when DataType.LOCATION is present in dataTypes.