Samsung Health Data SDK/com.samsung.android.sdk.health.data.data/HealthDataPoint

HealthDataPoint

A HealthDataPoint is an individual record of health data saved in the Samsung Health app's data store.

It has the following basic properties. Other fields vary according to the DataType.

Property	Description
uid	The data's unique identifier assigned by Samsung Health.
startTime	The start time of measurement, specified as Instant in milliseconds.
endTime	The end time of measurement, specified as Instant in milliseconds.
zoneOffset	The ZoneOffset for `startTime` and `endTime`.
dataSource	The data's source information including the application package name and which device's ID.
updateTime	The timestamp representing the last update of the data in the Samsung Health app's data store, specified as Instant in milliseconds. If no data update has occurred, it remains the same as `startTime`.
clientDataId	The optional data ID supplied by the app using Samsung Health Data SDK.
clientVersion	The optional data version supplied by the app using Samsung Health Data SDK.

Since

1.0.0

Types

Builder

class Builder

A builder to create a HealthDataPoint instance.

Companion

object Companion

Properties

clientDataId

val clientDataId: String?

The optional ID supplied by the client app associated with the data.

clientVersion

val clientVersion: Int?

The optional data version supplied by the client app associated with the data.

dataSource

val dataSource: DataSource?

The DataSource of the data, including the following information that provided the health data.

endTime

val endTime: Instant?

The end time of the data measurement. It is exclusive and specified as Instant in milliseconds.

startTime

val startTime: Instant

The start time of the data measurement. It is inclusive and specified as Instant in milliseconds.

uid

val uid: String

The unique identifier of the data, assigned at the time of insertion.

updateTime

val updateTime: Instant?

The timestamp representing the last update of the data in the Samsung Health app's data store, specified as Instant in milliseconds. If no data update has occurred, it remains the same as startTime.

zoneOffset

val zoneOffset: ZoneOffset?

The zone offset for the measured startTime and endTime of this data.

Functions

getEndLocalDateTime

fun getEndLocalDateTime(): LocalDateTime?

Retrieves the end time of the data as a LocalDateTime.

getStartLocalDateTime

fun getStartLocalDateTime(): LocalDateTime

Retrieves the start time of the data as a LocalDateTime.

getValue

fun <T> getValue(field: Field<T>): T?

Retrieves the value of the specified field.

getValueOrDefault

fun <T> getValueOrDefault(field: Field<T>, defaultValue: T): T

This is a generic type function, so the class type of the returned object is determined by the input field.

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.