Interface PolarTrainingSessionApi
-
- All Implemented Interfaces:
public interface PolarTrainingSessionApiPolar training session API.
Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
-
-
Method Summary
Modifier and Type Method Description abstract Flow<PolarTrainingSessionReference>getTrainingSessionReferences(String identifier, LocalDate fromDate, LocalDate toDate)Get training session references for a given period. abstract UnitdeleteTrainingSession(String identifier, PolarTrainingSessionReference reference)Api for removing single training session from a Polar device. abstract PolarTrainingSessiongetTrainingSession(String identifier, PolarTrainingSessionReference trainingSessionReference)Get training session. abstract Flow<PolarTrainingSessionFetchResult>getTrainingSessionWithProgress(String identifier, PolarTrainingSessionReference trainingSessionReference)Get training session with progress tracking. abstract UnitstartExercise(String identifier, PolarExerciseSession.SportProfile profile)Start an exercise session on the device. abstract UnitpauseExercise(String identifier)Pause an ongoing exercise session. abstract UnitresumeExercise(String identifier)Resume a paused exercise session. abstract UnitstopExercise(String identifier)Stop the current exercise session. abstract PolarExerciseSession.ExerciseInfogetExerciseStatus(String identifier)Get the current exercise session status from the device. abstract Flow<PolarExerciseSession.ExerciseInfo>observeExerciseStatus(String identifier)Observe exercise session status changes from the device. -
-
Method Detail
-
getTrainingSessionReferences
abstract Flow<PolarTrainingSessionReference> getTrainingSessionReferences(String identifier, LocalDate fromDate, LocalDate toDate)
Get training session references for a given period. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.fromDate- The starting date of the period to retrieve training session references from.toDate- The ending date of the period to retrieve training session references from.- Returns:
A Flow emitting PolarTrainingSessionReference objects representing the training session references for the specified period.
-
deleteTrainingSession
abstract Unit deleteTrainingSession(String identifier, PolarTrainingSessionReference reference)
Api for removing single training session from a Polar device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA You can get a list of training sessions with getTrainingSessionReferences API.
- Parameters:
identifier- The Polar device ID or BT address.reference- PolarTrainingSessionReference with path in device to the training session to be removed.
-
getTrainingSession
abstract PolarTrainingSession getTrainingSession(String identifier, PolarTrainingSessionReference trainingSessionReference)
Get training session. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.trainingSessionReference- The reference to the training session to retrieve.- Returns:
PolarTrainingSession object representing the training session data.
-
getTrainingSessionWithProgress
abstract Flow<PolarTrainingSessionFetchResult> getTrainingSessionWithProgress(String identifier, PolarTrainingSessionReference trainingSessionReference)
Get training session with progress tracking. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.trainingSessionReference- The reference to the training session to retrieve.- Returns:
A Flow emitting PolarTrainingSessionFetchResult objects with progress updates and final result.
-
startExercise
abstract Unit startExercise(String identifier, PolarExerciseSession.SportProfile profile)
Start an exercise session on the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.profile- The sport profile to use for the exercise session.
-
pauseExercise
abstract Unit pauseExercise(String identifier)
Pause an ongoing exercise session. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.
-
resumeExercise
abstract Unit resumeExercise(String identifier)
Resume a paused exercise session. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.
-
stopExercise
abstract Unit stopExercise(String identifier)
Stop the current exercise session. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
By default, the session is saved on the device.
- Parameters:
identifier- The Polar device ID or BT address.
-
getExerciseStatus
abstract PolarExerciseSession.ExerciseInfo getExerciseStatus(String identifier)
Get the current exercise session status from the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.- Returns:
The current PolarExerciseSession.ExerciseInfo for the device.
-
observeExerciseStatus
abstract Flow<PolarExerciseSession.ExerciseInfo> observeExerciseStatus(String identifier)
Observe exercise session status changes from the device. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_TRAINING_DATA
- Parameters:
identifier- The Polar device ID or BT address.- Returns:
A Flow emitting PolarExerciseSession.ExerciseInfo whenever the session status changes. Errors may include PolarErrors.
-
-
-
-