TotalCaloriesBurnedRecord
class TotalCaloriesBurnedRecord : Record
Total energy burned by the user (in kilocalories), including active & basal energy burned (BMR). Each record represents the total kilocalories burned over a time interval.
Summary
Public companion properties |
|
|---|---|
AggregateMetric<Energy> |
Metric identifier to retrieve total energy from |
Public constructors |
|---|
TotalCaloriesBurnedRecord( |
Public properties |
|
|---|---|
open Instant |
End time of the record. |
open ZoneOffset? |
User experienced zone offset at |
Energy |
Energy in |
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 |
Public companion properties
ENERGY_TOTAL
val ENERGY_TOTAL: AggregateMetric<Energy>
Metric identifier to retrieve total energy from androidx.health.connect.client.aggregate.AggregationResult.
Public constructors
TotalCaloriesBurnedRecord
TotalCaloriesBurnedRecord(
startTime: Instant,
startZoneOffset: ZoneOffset?,
endTime: Instant,
endZoneOffset: ZoneOffset?,
energy: Energy,
metadata: Metadata = Metadata.EMPTY
)
Public functions
Public properties
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.
energy
val energy: Energy
Energy in Energy unit. Required field. Valid range: 0-1000000 kcal.
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.