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

EnergyScoreType

class EnergyScoreType : DataType, DataType.Readable<HealthDataPoint, ReadDataRequest.LocalDateBuilder<HealthDataPoint>> , DataType.ChangeReadable<HealthDataPoint>

The data type for getting energy score data measured by the Samsung Health.

The energy score is the daily measurement of the user's physical and mental readiness. Analysis of the user's sleep, activity, and heart rate is used to calculate the score for the upcoming day. For more information, go to the Samsung Health application's Energy Score tracker.

Predefined instance

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

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. The EnergyScoreType provides read-only access.

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.
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.
ENERGY_SCORE[Mandatory]
The energy score.

Since

1.0.0

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

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

Retrieves a ChangedDataRequest instance to read changed energy score data.

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

Retrieves a ReadDataRequest instance to read energy score data.

Preferences Submitted

You have successfully updated your cookie preferences.