Search
Partnerships
Support
Health
Samsung Health Data SDK/com.samsung.android.sdk.health.data.request/DataType/HeartRateType

HeartRateType

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

The data type representing heart rate data specifications.

Continuous heart rate data from Galaxy wearable devices such as Galaxy Watch, Galaxy Fit, and Galaxy Ring can be recorded in this data type.

The Samsung Health application's settings provide a heart rate measurement option. If the user selects the option with 'Measure continuously' or 'Every 10 mins', the Galaxy wearable device will measure the user's heart rate accordingly. The measured data is then synchronized to the smartphone with HeartRateType data. Continuous heart rate details are stored in HeartRateType.SERIES_DATA.

Predefined instance

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

Available aggregate operations

  • MIN
    : To get the minimum heart rate value within the received heart rate data for a data request.

  • MAX
    : To get the maximum heart rate value within the received heart rate 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.

PropertyDescription
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.
HEART_RATE[Mandatory]
The heart rate value in beats per minute.
SERIES_DATAThe details regarding continuous heart rate. It is presented as the list of HeartRate.
MIN_HEART_RATEThe lowest heart rate value, in beats per minute.
MAX_HEART_RATEThe highest heart rate value, in beats per minute.

Since

1.0.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val changedDataRequestBuilder: ChangedDataRequest.BasicBuilder<HealthDataPoint>

Retrieves a ChangedDataRequest instance to retrieve changed heart rate data.

Link copied to clipboard
open override val deleteDataRequestBuilder: DeleteDataRequest.BasicBuilder

Retrieves a DeleteDataRequest instance to delete heart rate data that the application inserted into the Samsung Health.

Link copied to clipboard
open override val insertDataRequestBuilder: InsertDataRequest.BasicBuilder<HealthDataPoint>

Retrieves an InsertDataRequest instance to insert new heart rate data to the Samsung Health.

Link copied to clipboard
open override val readDataRequestBuilder: ReadDataRequest.DualTimeBuilder<HealthDataPoint>

Retrieves a ReadDataRequest instance to read heart rate data.

Link copied to clipboard
open override val updateDataRequestBuilder: UpdateDataRequest.BasicBuilder<HealthDataPoint>

Retrieves an UpdateDataRequest instance to update heart rate data that the application inserted into the Samsung Health.

Preferences Submitted

You have successfully updated your cookie preferences.