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

BodyCompositionType

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

The data type representing body composition data specifications.

Predefined instance

Using the following instance allows for obtaining heart rate 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.

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.
WEIGHT[Mandatory]
The weight value in kilograms.
HEIGHTThe height value in centimeters.
BASAL_METABOLIC_RATEThe basal metabolic rate (BMR) in kilocalories per day.
BODY_FATThe body fat as a percentage.
BODY_FAT_MASSThe body fat mass in kilograms.
FAT_FREEThe fat-free body mass as a percentage.
FAT_FREE_MASSThe fat-free body mass in kilograms.
MUSCLE_MASSThe muscle mass as a percentage.
SKELETAL_MUSCLEThe skeletal muscle mass as a percentage.
SKELETAL_MUSCLE_MASSThe skeletal muscle mass in kilograms.
TOTAL_BODY_WATERThe total amount of body water in liters.
BODY_MASS_INDEXThe body mass index (BMI) is a measure of body fat based on height and weight, calculated by the Samsung Health.

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 body composition data.

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

Retrieves a DeleteDataRequest instance to delete body composition 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 body composition data to the Samsung Health.

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

Retrieves a ReadDataRequest instance to read body composition data.

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

Retrieves an UpdateDataRequest instance to update body composition data that the application inserted into the Samsung Health.

Preferences Submitted

You have successfully updated your cookie preferences.