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

SleepApneaType

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

The data type representing sleep apnea data specifications.

Samsung Health Monitor monitors for severe obstructive sleep apnea with Galaxy Watch. Its sleep apnea risk detection feature detects signs that the user may have sleep apnea. If the user grants permission in the Samsung Health Monitor to synchronize its data with the Samsung Health app, Samsung Health Monitor syncs sleep apnea data with Samsung Health. For more information about the Samsung Health Monitor’s sleep apnea feature, visit Samsung Health Monitor.

Predefined instance

Using the following instance allows for obtaining sleep apnea 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 Permission for a code example.

Available operations

Data specifications

This data type includes the following properties.

PropertyDescription
uid[Mandatory]
The data's unique identifier assigned by Samsung Health.
startTime[Mandatory]
The timestamp representing the start of measurement, specified as Instant in milliseconds.
zoneOffset[Mandatory]
The ZoneOffset for startTime.
dataSource[Mandatory]
The data's source information including the application package name and the device ID.
DETECTED_SIGN[Mandatory]
The detected sign of sleep apnea.

Since

1.1.0

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum DetectedSign : Enum<DataType.SleepApneaType.DetectedSign>

The detected sign enum of sleep apnea.

Properties

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

Retrieves a ChangedDataRequest instance to read changed sleep apnea data.

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

Retrieves a ReadDataRequest instance to read sleep apnea data.

Preferences Submitted

You have successfully updated your cookie preferences.