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

BloodOxygenType

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

The data type representing blood oxygen level data specifications.

The Samsung Health measures continuous blood oxygen levels while sleeping. It's available through the Galaxy wearable device such as Galaxy Watch, Galaxy Fit, and Galaxy RING. If the "Blood Oxygen" option is enabled in the [Samsung Health] > [Sleep tracker] > [Advanced measurement], the data is automatically collected during sleep.

Predefined instance

Using the following instance allows for obtaining blood oxygen level 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.
endTime[Mandatory]
The timestamp representing the end 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.
OXYGEN_SATURATION[Mandatory]
The measured blood oxygen level in percentage.
SERIES_DATAThe details regarding continuous blood oxygen levels. It is represented as the list of OxygenSaturation.
MIN_OXYGEN_SATURATIONThe lowest blood oxygen level in percentage.
MAX_OXYGEN_SATURATIONThe highest blood oxygen level in percentage.

Associated data

The Samsung Health records blood oxygen levels and skin temperature data continuously during the user's sleep.

For a specific SleepType data record, getting associated data is available through:

Since

1.0.0

See also

Types

Link copied to clipboard
object Companion

Properties

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

Retrieves a ChangedDataRequest instance to retrieve changed blood oxygen level data.

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

Retrieves a DeleteDataRequest instance to delete blood oxygen level 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 blood oxygen level data to the Samsung Health.

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

Retrieves a ReadDataRequest instance to read blood oxygen level data.

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

Retrieves an UpdateDataRequest instance to update blood oxygen level data that the application inserted into the Samsung Health.

Preferences Submitted

You have successfully updated your cookie preferences.