PolarTrainingSessionApi Protocol Reference


                    
                    
                    getTrainingSessionReferences(identifier:fromDate:toDate:)

Asynchronous

Get training session references for a given period. If fromDate and toDate are not given this method will return all training session references in the device. Otherwise returns list of training session references from the specified closed or half-open date interval.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors.

Declaration

Swift

func getTrainingSessionReferences(
    identifier: String,
    fromDate: Date?,
    toDate: Date?
) async throws -> [PolarTrainingSessionReference]

Parameters

`identifier`	The Polar device ID or BT address.
`fromDate`	The starting date of the period to retrieve training session references from. Optional.
`toDate`	The ending date of the period to retrieve training session references from. Optional.

Return Value

An array of PolarTrainingSessionReference objects for the specified period.


                    
                    
                    getTrainingSession(identifier:trainingSessionReference:)

Asynchronous

Get a specific training session using a reference.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors.

Declaration

Swift

func getTrainingSession(
    identifier: String,
    trainingSessionReference: PolarTrainingSessionReference
) async throws -> PolarTrainingSession

Parameters

`identifier`	The Polar device ID or BT address.
`trainingSessionReference`	The reference to the training session to retrieve.

Return Value

PolarTrainingSession containing the session data.


                    
                    
                    getTrainingSessionWithProgress(identifier:trainingSessionReference:progressHandler:)

Asynchronous

Get a specific training session using a reference with progress updates.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors.

Declaration

Swift

func getTrainingSessionWithProgress(
    identifier: String,
    trainingSessionReference: PolarTrainingSessionReference,
    progressHandler: @escaping (PolarTrainingSessionProgress) -> Void
) async throws -> PolarTrainingSession

Parameters

`identifier`	The Polar device ID or BT address.
`trainingSessionReference`	The reference to the training session to retrieve.
`progressHandler`	A closure called with `PolarTrainingSessionProgress` as the session data is being fetched.

Return Value

PolarTrainingSession containing the complete session data.


                    
                    
                    deleteTrainingSession(identifier:reference:)

Asynchronous

Api for removing single training session from a Polar device. You can get a list of training sessions with getTrainingSessionReferences API.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors invoked.

Declaration

Swift

func deleteTrainingSession(identifier: String, reference: PolarTrainingSessionReference) async throws

Parameters

`identifier`	The Polar device ID or BT address.
`reference`	PolarTrainingSessionReference with path in device to the training session to be removed.


                    
                    
                    startExercise(identifier:profile:)

Asynchronous

Start an exercise session on the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors invoked.

Declaration

Swift

func startExercise(identifier: String, profile: PolarExerciseSession.SportProfile) async throws

Parameters

`identifier`	The Polar device ID or BT address.
`profile`	The sport profile to use for the exercise session.


                    
                    
                    pauseExercise(identifier:)

Asynchronous

Pause an ongoing exercise session.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors invoked.

Declaration

Swift

func pauseExercise(identifier: String) async throws

Parameters


                                identifier

The Polar device ID or BT address.


                    
                    
                    resumeExercise(identifier:)

Asynchronous

Resume a paused exercise session.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors invoked.

Declaration

Swift

func resumeExercise(identifier: String) async throws

Parameters


                                identifier

The Polar device ID or BT address.


                    
                    
                    stopExercise(identifier:)

Asynchronous

Stop the current exercise session.

By default, the session is saved on the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors invoked.

Declaration

Swift

func stopExercise(identifier: String) async throws

Parameters


                                identifier

The Polar device ID or BT address.


                    
                    
                    getExerciseStatus(identifier:)

Asynchronous

Get the current exercise session status from the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Throws

See PolarErrors for possible errors invoked.

Declaration

Swift

func getExerciseStatus(identifier: String) async throws -> PolarExerciseSession.ExerciseInfo

Parameters


                                identifier

The Polar device ID or BT address.

Return Value

The current PolarExerciseSession.ExerciseInfo for the device.


                    
                    
                    observeExerciseStatus(identifier:)

Observe exercise session status notifications from the device.

Requires

Requires SDK feature(s): PolarBleSdkFeature.feature_polar_training_data

Declaration

Swift

func observeExerciseStatus(identifier: String) -> AsyncThrowingStream<PolarExerciseSession.ExerciseInfo, Error>

Parameters


                                identifier

The Polar device ID or BT address.

Return Value

AsyncThrowingStream emitting PolarExerciseSession.ExerciseInfo whenever the session status changes.