ExerciseUpdate
public final class ExerciseUpdate
Contains the latest updated state and metrics for the current exercise.
Summary
Nested types |
|---|
public final class ExerciseUpdate.ActiveDurationCheckpointThis records the last time the exercise transitioned from an active to an inactive state or from an inactive to an active state, where inactive states match those found in |
Public methods |
|
|---|---|
boolean |
|
final @NonNull Duration |
getActiveDurationAtDataPoint(Returns the ActiveDuration of the exercise at the time of the provided |
final @NonNull Duration |
getActiveDurationAtDataPoint(Returns the ActiveDuration of the exercise at the time of the provided |
final ExerciseUpdate.ActiveDurationCheckpoint |
Returns the |
final ExerciseConfig |
Returns the |
final @NonNull ExerciseStateInfo |
Returns the |
final @NonNull Set<@NonNull DebouncedGoal<@NonNull Number>> |
Returns the latest |
final @NonNull Set<@NonNull ExerciseGoal<@NonNull Number>> |
Returns the latest |
final @NonNull DataPointContainer |
Returns the list of the latest |
final @NonNull Set<@NonNull MilestoneMarkerSummary> |
Returns the latest |
final Instant |
Returns the time at which the exercise was started or |
final @NonNull Duration |
Returns the duration since boot when this ExerciseUpdate was created. |
int |
hashCode() |
@NonNull String |
toString() |
Public methods
getActiveDurationAtDataPoint
public final @NonNull Duration getActiveDurationAtDataPoint(
@NonNull IntervalDataPoint<@NonNull ?> dataPoint
)
Returns the ActiveDuration of the exercise at the time of the provided IntervalDataPoint. The provided IntervalDataPoint should be present in this ExerciseUpdate.
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if |
kotlin.IllegalStateException |
if this |
getActiveDurationAtDataPoint
public final @NonNull Duration getActiveDurationAtDataPoint(
@NonNull SampleDataPoint<@NonNull ?> dataPoint
)
Returns the ActiveDuration of the exercise at the time of the provided SampleDataPoint. The provided SampleDataPoint should be present in this ExerciseUpdate.
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if |
getActiveDurationCheckpoint
public final ExerciseUpdate.ActiveDurationCheckpoint getActiveDurationCheckpoint()
Returns the ActiveDurationCheckpoint which can be used to determine the active duration of the exercise in a way that is consistent with Health Services. Clients can anchor their application timers against this to ensure their view of the active duration matches the view of Health Services.
getExerciseConfig
public final ExerciseConfig getExerciseConfig()
Returns the ExerciseConfig used by the exercise when the ExerciseUpdate was dispatched and returns null if the exercise is in prepare phase and hasn't been started yet.
getExerciseStateInfo
public final @NonNull ExerciseStateInfo getExerciseStateInfo()
Returns the ExerciseStateInfo containing the current ExerciseState and ExerciseEndReason, if applicable.
getLatestAchievedDebouncedGoals
public final @NonNull Set<@NonNull DebouncedGoal<@NonNull Number>> getLatestAchievedDebouncedGoals()
Returns the latest DebouncedGoals that have been achieved.
getLatestAchievedGoals
public final @NonNull Set<@NonNull ExerciseGoal<@NonNull Number>> getLatestAchievedGoals()
Returns the latest ExerciseGoalType.ONE_TIME_GOALs that have been achieved. ExerciseGoalType.MILESTONEs will be returned via latestMilestoneMarkerSummaries.
getLatestMetrics
public final @NonNull DataPointContainer getLatestMetrics()
Returns the list of the latest DataPoints.
getLatestMilestoneMarkerSummaries
public final @NonNull Set<@NonNull MilestoneMarkerSummary> getLatestMilestoneMarkerSummaries()
Returns the latest MilestoneMarkerSummarys.
getStartTime
public final Instant getStartTime()
Returns the time at which the exercise was started or null if the exercise is in prepare phase and hasn't started yet.
getUpdateDurationFromBoot
public final @NonNull Duration getUpdateDurationFromBoot()
Returns the duration since boot when this ExerciseUpdate was created.
| Throws | |
|---|---|
kotlin.IllegalStateException |
if this |