ExerciseCapabilities

Artifact: androidx.health:health-services-client

View Source

Added in 1.0.0

---

Kotlin |Java

class ExerciseCapabilities

---

Contains the capabilities supported by androidx.health.services.client.ExerciseClient on this device.

Summary

Public constructors
ExerciseCapabilities(     typeToCapabilities: Map<ExerciseType, ExerciseTypeCapabilities> )
ExerciseCapabilities(     typeToCapabilities: Map<ExerciseType, ExerciseTypeCapabilities>,     supportedBatchingModeOverrides: Set<BatchingMode> )

Public functions
ExerciseTypeCapabilities	getExerciseTypeCapabilities(exercise: ExerciseType) Returns the supported ExerciseTypeCapabilities for a requested ExerciseType.
open String	toString()

Public properties
Set<ExerciseType>	autoPauseAndResumeEnabledExercises Returns the set of ExerciseTypes that support auto pause and resume on this device.
Set<BatchingMode>	supportedBatchingModeOverrides Supported BatchingMode overrides on this device.
Set<ExerciseType>	supportedExerciseTypes Set of supported ExerciseType s on this device.
Map<ExerciseType, ExerciseTypeCapabilities>	typeToCapabilities Mapping for each supported ExerciseType to its ExerciseTypeCapabilities on this device.

Public constructors

ExerciseCapabilities

Added in 1.0.0

ExerciseCapabilities(
    typeToCapabilities: Map<ExerciseType, ExerciseTypeCapabilities>
)

ExerciseCapabilities

Added in 1.0.0

ExerciseCapabilities(
    typeToCapabilities: Map<ExerciseType, ExerciseTypeCapabilities>,
    supportedBatchingModeOverrides: Set<BatchingMode> = emptySet()
)

Public functions

getExerciseTypeCapabilities

Added in 1.0.0

fun getExerciseTypeCapabilities(exercise: ExerciseType): ExerciseTypeCapabilities

Returns the supported ExerciseTypeCapabilities for a requested ExerciseType.

Throws
kotlin.IllegalArgumentException	if the exercise is not supported

toString

open fun toString(): String

Public properties

autoPauseAndResumeEnabledExercises

Added in 1.0.0

val autoPauseAndResumeEnabledExercises: Set<ExerciseType>

Returns the set of ExerciseTypes that support auto pause and resume on this device.

supportedBatchingModeOverrides

Added in 1.0.0

val supportedBatchingModeOverrides: Set<BatchingMode>

Supported BatchingMode overrides on this device.

supportedExerciseTypes

Added in 1.0.0

val supportedExerciseTypes: Set<ExerciseType>

Set of supported ExerciseType s on this device.

typeToCapabilities

Added in 1.0.0

val typeToCapabilities: Map<ExerciseType, ExerciseTypeCapabilities>

Mapping for each supported ExerciseType to its ExerciseTypeCapabilities on this device.