public static interface HealthConstants.Sleep
extends HealthConstants.SessionMeasurement

This interface defines sleep data of the user.

It includes only the start and end time of sleep. If you want to log detailed sleep data, use HealthConstants.SleepStage with this data type.

Properties

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

• HealthConstants.Common
• HealthConstants.SessionMeasurement

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

Property name	Description
HealthConstants.Sleep.UUID	[Mandatory] Data's unique ID, assigned by the system when a new data is inserted
HealthConstants.Sleep.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.Sleep.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.Sleep.PACKAGE_NAME	[Mandatory] Package name which provides data, assigned by the system when a new data is inserted
HealthConstants.Sleep.DEVICE_UUID	[Mandatory] Device identifier which provides the health data
HealthConstants.Sleep.START_TIME	[Mandatory] UTC milliseconds when the measurement is started (when the user goes to bed)
HealthConstants.Sleep.END_TIME	[Mandatory] UTC milliseconds after the measurement has ended (when the user wakes up)
HealthConstants.Sleep.TIME_OFFSET	[Mandatory] Time offset in milliseconds which considers the time zone and daylight saving time
HealthConstants.Sleep.COMMENT	Comment
HealthConstants.Sleep.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.