Samsung Health Data SDK/com.samsung.android.sdk.health.data.request/DataType/ExerciseType

ExerciseType

class ExerciseType : DataType, DataType.Readable<HealthDataPoint, ReadDataRequest.DualTimeBuilder<HealthDataPoint>> , DataType.ChangeReadable<HealthDataPoint> , DataType.Writeable<HealthDataPoint>

The data type representing exercise data specifications.

One ExerciseType data record includes one or more ExerciseSessions.

Each ExerciseSession indicates a single exercise activity with:

An EXERCISE_TYPE like PredefinedExerciseType.WALKING or PredefinedExerciseType.RUNNING
The exercise's details such as ExerciseSession.duration and ExerciseSession.calories

This allows for flexibility in recording diverse types of exercise activities.

If a single running exercise activity is provided with the ExerciseType, the ExerciseType data record includes one ExerciseSession for the RUNNING exercise type.

In case of triathlon, it can be expressed with one the ExerciseType data record including 3 ExerciseSessions for SWIMMING, BIKING, and RUNNING.

Predefined instance

Using the following instance allows for obtaining exercise data with more concise code.

DataTypes.EXERCISE

Available aggregate operations

TOTAL_CALORIES
: To get the total calories within the received exercise data for a data request.
TOTAL_DURATION
: To get the total duration within the received exercise data for a data request.

Required permission

The user's consent is required to access this data type. Check the granted permissions and request permissions if the required permission is not granted yet with:

See a code example in here.

Available requests

Data specifications

This data type includes the following information.

Property	Description
uid	[Mandatory] The data's unique identifier assigned by the Samsung Health.
startTime	[Mandatory] The timestamp representing the start of measurement, specified as Instant, in milliseconds.
endTime	[Mandatory] The timestamp representing the end of measurement, specified as Instant, in milliseconds.
zoneOffset	[Mandatory] The ZoneOffset for `startTime` and `endTime`.
dataSource	[Mandatory] The data's source information including the application package name and which device's ID.
EXERCISE_TYPE	[Mandatory] The exercise type.
SESSIONS	[Mandatory] The list of ExerciseSession.
CUSTOM_TITLE	The custom title of the exercise type. It's used if there is no proper PredefinedExerciseType for the EXERCISE_TYPE.

Auto detect workouts of Galaxy wearable

The Galaxy Watch, Galaxy Fit, and Galaxy Ring support the auto-detect workouts feature. If the user enabled the [Samsung Health] > [Settings] > [Activities to detect[, the Samsung Health detects the user's workout automatically and records the detected workout data as ExerciseType data.

Inserting exercise data into Samsung Health

For inserting exercise data into the Samsung Health, please take note of the following:

ExerciseType data containing one ExerciseSession can be written in Samsung Health.
Set the ExerciseType.startTime to match the ExerciseSession.startTime.
Set the ExerciseType.endTime to match the ExerciseSession.endTime.
Set the EXERCISE_TYPE to match the ExerciseSession.exerciseType.
Some PredefinedExerciseTypes do not support inserting ExerciseType data.

TRIATHLON
DUATHLON
AQUATHLON
AQUABIKE
CROSS_TRIATHLON
CROSS_DUATHLON
BREAK
COOL_DOWN
WARM_UP
TRANSITION

If there are two or more ExerciseSessions in the exercise data, set the startTime and endTime of each ExerciseSession within the range of startTime and endTime of the ExerciseType data, and ensure they do not overlap with any other ExerciseSession within the ExerciseType data.

Since

1.0.0

Types

Companion

object Companion

CountType

enum CountType : Enum<DataType.ExerciseType.CountType>

The count type for a countable exercise.

PredefinedExerciseType

enum PredefinedExerciseType : Enum<DataType.ExerciseType.PredefinedExerciseType>

An exercise type.

StrokeType

enum StrokeType : Enum<DataType.ExerciseType.StrokeType>

The type of swimming stroke.

Properties

changedDataRequestBuilder

open override val changedDataRequestBuilder: ChangedDataRequest.BasicBuilder<HealthDataPoint>

Retrieves a ChangedDataRequest instance to retrieve changed exercise data.

deleteDataRequestBuilder

open override val deleteDataRequestBuilder: DeleteDataRequest.BasicBuilder

Gets the appropriate builder for creating DeleteDataRequest.

insertDataRequestBuilder

open override val insertDataRequestBuilder: InsertDataRequest.BasicBuilder<HealthDataPoint>

Gets the appropriate builder for creating InsertDataRequest.

readDataRequestBuilder

open override val readDataRequestBuilder: ReadDataRequest.DualTimeBuilder<HealthDataPoint>

Retrieves a ReadDataRequest instance to read exercise data.

updateDataRequestBuilder

open override val updateDataRequestBuilder: UpdateDataRequest.BasicBuilder<HealthDataPoint>

Gets the appropriate builder for creating UpdateDataRequest.

Essential Cookies

These cookies are essential as they enable you to move around the website. This category cannot be disabled.

Analytical/Performance Cookies

These cookies collect information about how you use our website. for example which pages you visit most often. All information these cookies collect is used to improve how the website works.

Functionality Cookies

These cookies allow our website to remember choices you make (such as your user name, language or the region your are in) and tailor the website to provide enhanced features and content for you.

Advertising Cookies

These cookies gather information about your browser habits. They remember that you've visited our website and share this information with other organizations such as advertisers.