ExerciseConfig
class ExerciseConfig
Defines configuration for an exercise tracked using Health Services.
Summary
Nested types |
|---|
class ExerciseConfig.BuilderBuilder for |
Constants |
|
|---|---|
const Float |
Public companion functions |
|
|---|---|
ExerciseConfig.Builder |
builder(exerciseType: ExerciseType)Returns a fresh new |
Public constructors |
|---|
ExerciseConfig(Creates a new ExerciseConfig for an exercise tracked using Health Services |
Public properties |
|
|---|---|
Set<BatchingMode> |
|
Set<DataType<*, *>> |
|
List<DebouncedGoal<*>> |
|
Set<ExerciseEventType<*>> |
|
List<ExerciseGoal<*>> |
|
Bundle |
|
ExerciseType |
|
ExerciseTypeConfig? |
|
Boolean |
whether auto-pause/resume is enabled for this exercise |
Boolean |
whether GPS is enabled for this exercise. |
Float |
length (in meters) of the swimming pool, or 0 if not relevant to this exercise |
Constants
Public companion functions
builder
fun builder(exerciseType: ExerciseType): ExerciseConfig.Builder
Returns a fresh new Builder.
| Parameters | |
|---|---|
exerciseType: ExerciseType |
the |
Public constructors
ExerciseConfig
ExerciseConfig(
exerciseType: ExerciseType,
dataTypes: Set<DataType<*, *>>,
isAutoPauseAndResumeEnabled: Boolean,
isGpsEnabled: Boolean,
exerciseGoals: List<ExerciseGoal<*>> = listOf(),
exerciseParams: Bundle = Bundle(),
swimmingPoolLengthMeters: @FloatRange(from = 0.0) Float = SWIMMING_POOL_LENGTH_UNSPECIFIED,
exerciseTypeConfig: ExerciseTypeConfig? = null,
batchingModeOverrides: Set<BatchingMode> = emptySet(),
exerciseEventTypes: Set<ExerciseEventType<*>> = emptySet(),
debouncedGoals: List<DebouncedGoal<*>> = emptyList()
)
Creates a new ExerciseConfig for an exercise tracked using Health Services
Public properties
batchingModeOverrides
val batchingModeOverrides: Set<BatchingMode>
BatchingMode overrides for this exercise
dataTypes
val dataTypes: Set<DataType<*, *>>
DataType which will be tracked for this exercise
debouncedGoals
val debouncedGoals: List<DebouncedGoal<*>>
DebouncedGoals for this exercise. DataTypes in DebouncedGoals must also be tracked.
exerciseEventTypes
val exerciseEventTypes: Set<ExerciseEventType<*>>
ExerciseEventTypes which should be tracked for this exercise
exerciseGoals
val exerciseGoals: List<ExerciseGoal<*>>
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.
exerciseParams
val exerciseParams: Bundle
Bundle bundle for specifying exercise presets, the values of an on-going exercise which can be used to pre-populate a new exercise.
exerciseType
val exerciseType: ExerciseType
ExerciseType user is performing for this exercise
exerciseTypeConfig
val exerciseTypeConfig: ExerciseTypeConfig?
ExerciseTypeConfig containing attributes which may be modified after the exercise has started
isAutoPauseAndResumeEnabled
val isAutoPauseAndResumeEnabled: Boolean
whether auto-pause/resume is enabled for this exercise
isGpsEnabled
val isGpsEnabled: Boolean
whether GPS is enabled for this exercise. Must be set to true when DataType.LOCATION is present in dataTypes.
swimmingPoolLengthMeters
val swimmingPoolLengthMeters: Float
length (in meters) of the swimming pool, or 0 if not relevant to this exercise