Overview Package Class Tree Deprecated Index

All Superinterfaces:: HealthConstants.Common, HealthConstants.DiscreteMeasurement

Enclosing class:: HealthConstants

public static interface HealthConstants.Weight
extends HealthConstants.DiscreteMeasurement

This interface defines weight data of the user.

Properties

Properties of the following extending interfaces are available for this data type.

Weight data has the following properties.
See more common properties by spreading this section out.

Property name	Description
HealthConstants.Weight.UUID	[Mandatory] Data's unique ID, assigned by the system when a new data is inserted
HealthConstants.Weight.CREATE_TIME	[Mandatory] UTC milliseconds when a data is created in the health data store, assigned by the system when a new data is inserted
HealthConstants.Weight.UPDATE_TIME	[Mandatory] UTC milliseconds when a data is updated in the health data store, assigned by the system when a new data is inserted or the existing data is updated
HealthConstants.Weight.PACKAGE_NAME	[Mandatory] Package name which provides data, assigned by the system when a new data is inserted
HealthConstants.Weight.DEVICE_UUID	[Mandatory] Device identifier of the source device which provides the health data
HealthConstants.Weight.START_TIME	[Mandatory] UTC milliseconds when data is created to the health data store when the measurement is started
HealthConstants.Weight.TIME_OFFSET	[Mandatory] Time offset in milliseconds which considers the time zone and daylight saving time
HealthConstants.Weight.WEIGHT	[Mandatory] Measured weight value
HealthConstants.Weight.HEIGHT	Height
HealthConstants.Weight.BODY_FAT	Body fat
HealthConstants.Weight.SKELETAL_MUSCLE	Skeletal muscle
HealthConstants.Weight.MUSCLE_MASS	Muscle mass
HealthConstants.Weight.BASAL_METABOLIC_RATE	BMR
HealthConstants.Weight.BODY_FAT_MASS	Body fat mass
HealthConstants.Weight.FAT_FREE_MASS	Fat-free mass
HealthConstants.Weight.FAT_FREE	Fat-free ratio
HealthConstants.Weight.SKELETAL_MUSCLE_MASS	Skeletal muscle mass
HealthConstants.Weight.TOTAL_BODY_WATER	Total body water
HealthConstants.Weight.COMMENT	Comment
HealthConstants.Weight.CUSTOM	Custom info which is formatted with JSON and compressed data

Data Permission

The user's consent is required to read or write this data type. HealthPermissionManager.requestPermissions() displays a data permission UI to the user.
See Permission Manager and request data permission.

Since:: 1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASAL_METABOLIC_RATE` BMR in kcal per day.
`static String`	`BODY_FAT` Body fat in percentage.
`static String`	`BODY_FAT_MASS` Body fat mass in kilograms.
`static String`	`COMMENT` Comment for data.
`static String`	`FAT_FREE` Fat-free ratio in percentage.
`static String`	`FAT_FREE_MASS` Fat-free mass in kilograms.
`static String`	`HEALTH_DATA_TYPE` Data type name for weight data.
`static String`	`HEIGHT` Height in centimeters.
`static String`	`MUSCLE_MASS` Muscle mass in percentage.
`static String`	`SKELETAL_MUSCLE` Skeletal muscle in percentage.
`static String`	`SKELETAL_MUSCLE_MASS` Skeletal muscle mass in kilograms.
`static String`	`TOTAL_BODY_WATER` Total body water in liters.
`static String`	`WEIGHT` Weight in kilograms.

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.DiscreteMeasurement
START_TIME, TIME_OFFSET

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.Common
CREATE_TIME, CUSTOM, DEVICE_UUID, PACKAGE_NAME, UPDATE_TIME, UUID

- Field Detail
  - COMMENT
```
static final String COMMENT
```
    Comment for data.
    - Optional
    - Type: String
    - Value length: 0 ~ 255
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - WEIGHT
```
static final String WEIGHT
```
    Weight in kilograms.
    - Mandatory
    - Type: float
    - Value range: 2 ~ 500
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - HEIGHT
```
static final String HEIGHT
```
    Height in centimeters.
    - Optional
    - Type: float
    - Value range: 20 ~ 300
    Since:
    
    1.0.0
    
    See Also:
    
    Constant Field Values
  - BODY_FAT
```
static final String BODY_FAT
```
    Body fat in percentage. Total mass of fat divided by total body mass.
    - Optional
    - Type: float
    - Value range: 1 ~ 75
    Since:
    
    1.2.0
    
    See Also:
    
    Constant Field Values
  - SKELETAL_MUSCLE
```
static final String SKELETAL_MUSCLE
```
    Skeletal muscle in percentage. Total mass of skeletal muscle divided by total muscle mass.
    - Optional
    - Type: float
    - Value range: 5 ~ 90
    Since:
    
    1.2.0
    
    See Also:
    
    Constant Field Values
  - MUSCLE_MASS
```
static final String MUSCLE_MASS
```
    Muscle mass in percentage. Total mass of muscle divided by total body mass.
    - Optional
    - Type: float
    - Value range: 10 ~ 99
    Since:
    
    1.2.0
    
    See Also:
    
    Constant Field Values
  - BASAL_METABOLIC_RATE
```
static final String BASAL_METABOLIC_RATE
```
    BMR in kcal per day.
    - Optional
    - Type: int
    - Value range: 100 ~ 10000
    Since:
    
    1.2.0
    
    See Also:
    
    Constant Field Values
  - BODY_FAT_MASS
```
static final String BODY_FAT_MASS
```
    Body fat mass in kilograms.
    - Optional
    - Type: float
    - Value range: 2 ~ 500
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - FAT_FREE_MASS
```
static final String FAT_FREE_MASS
```
    Fat-free mass in kilograms.
    - Optional
    - Type: float
    - Value range: 2 ~ 500
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - FAT_FREE
```
static final String FAT_FREE
```
    Fat-free ratio in percentage.
    - Optional
    - Type: float
    - Value range: 0 ~ 100
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - SKELETAL_MUSCLE_MASS
```
static final String SKELETAL_MUSCLE_MASS
```
    Skeletal muscle mass in kilograms.
    - Optional
    - Type: float
    - Value range: 2 ~ 500
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - TOTAL_BODY_WATER
```
static final String TOTAL_BODY_WATER
```
    Total body water in liters.
    - Optional
    - Type: float
    - Value range: 2 ~ 500
    Since:
    
    1.3.0
    
    See Also:
    
    Constant Field Values
  - HEALTH_DATA_TYPE
```
static final String HEALTH_DATA_TYPE
```
    Data type name for weight data.
    Use "com.samsung.health.weight" to add permission to the manifest file.
    
    See Also:
    
    Constant Field Values

Interface HealthConstants.Weight

Properties

Data Permission

Field Summary

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.DiscreteMeasurement

Fields inherited from interface com.samsung.android.sdk.healthdata.HealthConstants.Common

Field Detail

COMMENT

WEIGHT

HEIGHT

BODY_FAT

SKELETAL_MUSCLE

MUSCLE_MASS

BASAL_METABOLIC_RATE

BODY_FAT_MASS

FAT_FREE_MASS

FAT_FREE

SKELETAL_MUSCLE_MASS

TOTAL_BODY_WATER

HEALTH_DATA_TYPE