com.samsung.android.sdk.healthdata

Class HealthConstants

java.lang.Object

com.samsung.android.sdk.healthdata.HealthConstants

public final class HealthConstants
extends Object

This class contains interfaces for Samsung Health Android SDK's data types such as counting steps or exercise.

The SDK provides:

• Predefined data type including the user's profile
• Custom data type

Samsung Health's health data can be accessed after acquiring data permission through HealthPermissionManager.

Common Properties for Data Type

HealthConstants.Common identifies common properties of health data. Its values are assigned by the system when a new health data is inserted.

• Health data's unique ID
• Data creation time
• Data's Update time
• Application package name that provides the health data
• Device identifier which provides the health data
• Custom info

The predefined data type extends one of the following interfaces according to its characteristics.

Discrete Measurement

HealthConstants.DiscreteMeasurement defines basic measurement information.

• Start time of measurement
• Time zone

Session Measurement

HealthConstants.SessionMeasurement defines measurement information that has a session with the end time.

• Start time of measurement
• End time of measurement
• Time zone

Predefined Data Type

The health data framework has the following useful predefined data types.

• Activity
• Daily step count trend
• HealthConstants.StepCount
• HealthConstants.Exercise
• HealthConstants.FloorsClimbed
• Rest
• HealthConstants.Sleep
• HealthConstants.SleepStage
• Food
• HealthConstants.Nutrition
• HealthConstants.WaterIntake
• HealthConstants.CaffeineIntake
• Health Care
• HealthConstants.BodyTemperature
• HealthConstants.BloodPressure
• HealthConstants.BloodGlucose
• HealthConstants.Electrocardiogram
• HealthConstants.HeartRate
• HealthConstants.HipCircumference
• HealthConstants.OxygenSaturation
• HealthConstants.HbA1c
• HealthConstants.Height
• HealthConstants.WaistCircumference
• HealthConstants.Weight
• <<Show more...>>
HealthConstants.Albumin
HealthConstants.Alp
HealthConstants.Alt
HealthConstants.Amylase
HealthConstants.Ast
HealthConstants.BodyFat
HealthConstants.BodyMuscle
HealthConstants.Bun
HealthConstants.Cpk
HealthConstants.Creatinine
HealthConstants.DirectBilirubin
HealthConstants.Fev1
HealthConstants.Fvc
HealthConstants.Ggt
HealthConstants.Globulin
HealthConstants.Hdlc
HealthConstants.Homocysteine
HealthConstants.Ldh
HealthConstants.Ldlc
HealthConstants.TotalBilirubin
HealthConstants.TotalCholesterol
HealthConstants.TotalProtein
HealthConstants.Triglyceride
HealthConstants.Uph
HealthConstants.Usg
<<Show little...>>
• Health Document
• HealthConstants.HealthDocument
• Environment Info
• HealthConstants.AmbientTemperature
• HealthConstants.UvExposure
• User Profile
• HealthUserProfile (read-only)

HealthConstants.Common is a basic class for all predefined data types except HealthUserProfile. It is extended to:

• HealthConstants.DiscreteMeasurement
  Abstract data type interface which have only the start time of measurement without the end time. It is for general measured data.
• HealthConstants.SessionMeasurement
  Abstract data type interface which have the end time of measurement with the start time.

HealthConstants.SessionMeasurement and its extended data types are shown in the following class diagram.

HealthConstants.DiscreteMeasurement and its extended data types are shown in the following class diagram.

Custom Data Type

The custom data type is defining a new data type definition if there is no proper data type in predefined ones.
In case that you just needs to add more properties to the predefined data type, use HealthConstants.Common.CUSTOM in the predefined data type.

There is an opened custom data type that Samsung Health provides:

• Daily step count trend

A new custom data type definition and a registration needs a Samsung Health team's approval. Contact dev.shealth@samsung.com for more information.

The custom health data type's name follows the FQDN (fully qualified domain name) style without name collision. You can find the data type name of HealthConstants.BloodGlucose is:

E.g. "com.samsung.health.blood_glucose"

The custom health data type can be defined with all new properties or with importing the existing predefined data type.
The following common properties are mandatory for the custom data type.

• "datauuid" (String): the unique ID of a health data. It's assigned by the system when a data is inserted.
• "create_time" (long): the created time of a health data. It's assigned by the system when a data is inserted.
• "update_time" (long): the updated time of a health data. It's assigned by the system when a data is inserted and updated.
• "pkg_name" (String): the application package name that provides a health data. It's assigned by the system when a data is inserted.
• "deviceuuid" (String): the device identifier. It needs to set with HealthData.setSourceDevice(String) when a data is inserted.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HealthConstants.Albumin This interface defines albumin data of the user.
static interface	HealthConstants.Alp This interface defines ALP (Alkaline Phosphatase) data of the user.
static interface	HealthConstants.Alt This interface defines ALT(Alanine Aminotransferase) data of the user.
static interface	HealthConstants.AmbientTemperature This interface defines ambient temperature and humidity data around the device.
static interface	HealthConstants.Amylase This interface defines Amylase data of the user.
static interface	HealthConstants.Ast This interface defines AST (Aspartate Aminotransferase) data of the user.
static interface	HealthConstants.BloodGlucose This interface defines blood glucose data of the user.
static interface	HealthConstants.BloodPressure This interface defines blood pressure data of the user.
static interface	HealthConstants.BodyFat This interface defines body fat data of the user.
static interface	HealthConstants.BodyMuscle This interface defines body muscle data of the user.
static interface	HealthConstants.BodyTemperature This interface defines body temperature data of the user.
static interface	HealthConstants.Bun This interface defines BUN (Blood Urea Nitrogen) data of the user.
static interface	HealthConstants.CaffeineIntake This interface defines caffeine intake data of the user.
static interface	HealthConstants.Common This interface contains the common constants for health data such as the data's unique ID, the application package name which provides data, and the data's source device information.
static interface	HealthConstants.Cpk This interface defines CPK (Creatine Phosphokinase) data of the user.
static interface	HealthConstants.Creatinine This interface defines creatinine data of the user.
static interface	HealthConstants.DirectBilirubin This interface defines direct bilirubin data of the user.
static interface	HealthConstants.DiscreteMeasurement This interface contains basic constants for measurement such as the start or offset time.
static interface	HealthConstants.Electrocardiogram This interface defines electrocardiogram data of the user.
static interface	HealthConstants.Exercise This interface defines exercise data of the user.
static interface	HealthConstants.Fev1 This interface defines FEV1 (Forced Expiratory Volume in One Second) data of the user.
static interface	HealthConstants.FloorsClimbed This interface defines floors climbed data of the user.
static interface	HealthConstants.FoodInfo Deprecated. Use HealthConstants.Nutrition instead of it. This data type will be removed. Do not use it any more.
static interface	HealthConstants.FoodIntake Deprecated. Use HealthConstants.Nutrition instead of it. This data type will be removed. Do not use it any more.
static interface	HealthConstants.Fvc This interface defines FVC (Forced Vital Capacity) data of the user.
static interface	HealthConstants.Ggt This interface defines GGT (Gamma Glutamyl Transpeptidase) data of the user.
static interface	HealthConstants.Globulin This interface defines globulin data of the user.
static interface	HealthConstants.HbA1c This interface defines glycated hemoglobin data of the user.
static interface	HealthConstants.Hdlc This interface defines HDL-C(High-Density Lipoprotein Cholesterol) data of the user.
static interface	HealthConstants.HealthDocument This interface defines health docuemnt data of the user.
static interface	HealthConstants.HeartRate This interface defines heart rate data of the user.
static interface	HealthConstants.Height This interface defines height data of the user.
static interface	HealthConstants.HipCircumference This interface defines hip circumference data of the user.
static interface	HealthConstants.Homocysteine This interface defines homocysteine data of the user.
static interface	HealthConstants.Ldh This interface defines LDH (Lactate Dehydrogenase) data of the user.
static interface	HealthConstants.Ldlc This interface defines LDL-C (Low-Density Lipoprotein Cholesterol) data of the user.
static interface	HealthConstants.Nutrition This interface defines nutrition user intakes.
static interface	HealthConstants.OxygenSaturation This interface defines oxygen saturation data in the user's blood.
static interface	HealthConstants.SessionMeasurement This interface contains measurement constants that has a session with the end time.
static interface	HealthConstants.Sleep This interface defines sleep data of the user.
static interface	HealthConstants.SleepStage This interface defines the detailed sleep stage for the specified sleep data.
static interface	HealthConstants.StepCount This interface defines the user's step count data.
static interface	HealthConstants.TotalBilirubin This interface defines total bilirubin data of the user.
static interface	HealthConstants.TotalCholesterol This interface defines total cholesterol data of the user.
static interface	HealthConstants.TotalProtein This interface defines total protein data of the user.
static interface	HealthConstants.Triglyceride This interface defines triglyceride data of the user.
static interface	HealthConstants.Uph This interface defines UPH (Urine pH) data of the user.
static interface	HealthConstants.Usg This interface defines USG (Urine Specific Gravity) data of the user.
static interface	HealthConstants.UvExposure This interface defines UV exposure data around the device.
static interface	HealthConstants.WaistCircumference This interface defines waist circumference data of the user.
static interface	HealthConstants.WaterIntake This interface defines water intake data of the user.
static interface	HealthConstants.Weight This interface defines weight data of the user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_PROFILE_DATA_TYPE Data type name for the user profile.

Constructor Summary

Constructors

Constructor and Description
HealthConstants()

Field Detail

USER_PROFILE_DATA_TYPE

public static final String USER_PROFILE_DATA_TYPE

Data type name for the user profile.
Use "com.samsung.health.user_profile" to add permission to the manifest file.

The user profile is available to read only and can be retrieved with HealthUserProfile.

See Also:

Constant Field Values

Constructor Detail

HealthConstants

public HealthConstants()