SkinTemperatureRecord
class SkinTemperatureRecord : Record
Captures the skin temperature of a user. Each record can represent a series of measurements of temperature differences.
The ability to insert or read this record type is dependent on the version of HealthConnect installed on the device. To check if available: call HealthConnectFeatures.getFeatureStatus and pass HealthConnectFeatures.FEATURE_SKIN_TEMPERATURE as an argument. See further down for an example on how to read skin temperature.
import androidx.health.connect.client.HealthConnectFeatures
import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.readRecord
import androidx.health.connect.client.records.SkinTemperatureRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
if (
healthConnectClient.features.getFeatureStatus(
HealthConnectFeatures.FEATURE_SKIN_TEMPERATURE
) == HealthConnectFeatures.FEATURE_STATUS_AVAILABLE
) {
if (
healthConnectClient.permissionController
.getGrantedPermissions()
.contains(HealthPermission.getReadPermission(SkinTemperatureRecord::class))
) {
val response =
healthConnectClient.readRecords(
ReadRecordsRequest<SkinTemperatureRecord>(
timeRangeFilter = TimeRangeFilter.between(startTime, endTime)
)
)
for (skinTemperatureRecord in response.records) {
// Process each skin temperature record
}
} else {
// Permission hasn't been granted. Request permission to read skin temperature.
}
} else {
// Feature is not available. It is not possible to read skin temperature.
}
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if |
Summary
Nested types |
|---|
|
Represents a skin temperature delta entry of |
Constants |
|
|---|---|
const Int |
Skin temperature measurement was taken from finger. |
const Int |
Skin temperature measurement was taken from toe. |
const Int |
Use this if the location is unknown. |
const Int |
Skin temperature measurement was taken from wrist. |
Public companion properties |
|
|---|---|
AggregateMetric<TemperatureDelta> |
Metric identifier for retrieving the average skin temperature delta from |
AggregateMetric<TemperatureDelta> |
Metric identifier for retrieving the maximum skin temperature delta from |
AggregateMetric<TemperatureDelta> |
Metric identifier for retrieving the minimum skin temperature delta from |
Public constructors |
|---|
SkinTemperatureRecord( |
Public properties |
|
|---|---|
Temperature? |
Temperature in |
List<SkinTemperatureRecord.Delta> |
a list of skin temperature |
open Instant |
End time of the record. |
open ZoneOffset? |
User experienced zone offset at |
Int |
indicates the location on the body from which the temperature reading was taken. |
open Metadata |
set of common metadata associated with the written record. |
open Instant |
Start time of the record. |
open ZoneOffset? |
User experienced zone offset at |
Constants
MEASUREMENT_LOCATION_FINGER
const val MEASUREMENT_LOCATION_FINGER = 1: Int
Skin temperature measurement was taken from finger.
MEASUREMENT_LOCATION_TOE
const val MEASUREMENT_LOCATION_TOE = 2: Int
Skin temperature measurement was taken from toe.
MEASUREMENT_LOCATION_UNKNOWN
const val MEASUREMENT_LOCATION_UNKNOWN = 0: Int
Use this if the location is unknown.
MEASUREMENT_LOCATION_WRIST
const val MEASUREMENT_LOCATION_WRIST = 3: Int
Skin temperature measurement was taken from wrist.
Public companion properties
TEMPERATURE_DELTA_AVG
val TEMPERATURE_DELTA_AVG: AggregateMetric<TemperatureDelta>
Metric identifier for retrieving the average skin temperature delta from androidx.health.connect.client.aggregate.AggregationResult. To check if this metric is available, use HealthConnectFeatures.getFeatureStatus with HealthConnectFeatures.FEATURE_SKIN_TEMPERATURE as the argument.
TEMPERATURE_DELTA_MAX
val TEMPERATURE_DELTA_MAX: AggregateMetric<TemperatureDelta>
Metric identifier for retrieving the maximum skin temperature delta from androidx.health.connect.client.aggregate.AggregationResult. To check if this metric is available, use HealthConnectFeatures.getFeatureStatus with HealthConnectFeatures.FEATURE_SKIN_TEMPERATURE as the argument.
TEMPERATURE_DELTA_MIN
val TEMPERATURE_DELTA_MIN: AggregateMetric<TemperatureDelta>
Metric identifier for retrieving the minimum skin temperature delta from androidx.health.connect.client.aggregate.AggregationResult. To check if this metric is available, use HealthConnectFeatures.getFeatureStatus with HealthConnectFeatures.FEATURE_SKIN_TEMPERATURE as the argument.
Public constructors
SkinTemperatureRecord
SkinTemperatureRecord(
startTime: Instant,
startZoneOffset: ZoneOffset?,
endTime: Instant,
endZoneOffset: ZoneOffset?,
deltas: List<SkinTemperatureRecord.Delta>,
baseline: Temperature? = null,
measurementLocation: Int = MEASUREMENT_LOCATION_UNKNOWN,
metadata: Metadata = Metadata.EMPTY
)
| Parameters | |
|---|---|
startTime: Instant |
Start time of the record. |
startZoneOffset: ZoneOffset? |
User experienced zone offset at |
endTime: Instant |
End time of the record. |
endZoneOffset: ZoneOffset? |
User experienced zone offset at |
deltas: List<SkinTemperatureRecord.Delta> |
a list of skin temperature |
baseline: Temperature? = null |
Temperature in |
measurementLocation: Int = MEASUREMENT_LOCATION_UNKNOWN |
indicates the location on the body from which the temperature reading was taken. Optional field, |
metadata: Metadata = Metadata.EMPTY |
set of common metadata associated with the written record. |
Public functions
Public properties
baseline
val baseline: Temperature?
Temperature in Temperature unit. Optional field, null by default. Valid range: 0-100 Celsius degrees.
deltas
val deltas: List<SkinTemperatureRecord.Delta>
a list of skin temperature Delta. If baseline is set, these values are expected to be relative to it.
endZoneOffset
open val endZoneOffset: ZoneOffset?
User experienced zone offset at endTime, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.
measurementLocation
val measurementLocation: Int
indicates the location on the body from which the temperature reading was taken. Optional field, MEASUREMENT_LOCATION_UNKNOWN by default. Allowed values: SkinTemperatureMeasurementLocation.
metadata
open val metadata: Metadata
set of common metadata associated with the written record.
startZoneOffset
open val startZoneOffset: ZoneOffset?
User experienced zone offset at startTime, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.