TotalCaloriesBurnedRecord
public final class TotalCaloriesBurnedRecord implements 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 fields |
|
|---|---|
static final @NonNull AggregateMetric<@NonNull Energy> |
Metric identifier to retrieve total energy from |
Public constructors |
|---|
TotalCaloriesBurnedRecord( |
Public methods |
|
|---|---|
boolean |
|
@NonNull Instant |
End time of the record. |
ZoneOffset |
User experienced zone offset at |
final @NonNull Energy |
Energy in |
@NonNull Metadata |
Set of common metadata associated with the written record. |
@NonNull Instant |
Start time of the record. |
ZoneOffset |
User experienced zone offset at |
int |
hashCode() |
@NonNull String |
toString() |
Public fields
ENERGY_TOTAL
public static final @NonNull AggregateMetric<@NonNull Energy> ENERGY_TOTAL
Metric identifier to retrieve total energy from androidx.health.connect.client.aggregate.AggregationResult.
Public constructors
TotalCaloriesBurnedRecord
public TotalCaloriesBurnedRecord(
@NonNull Instant startTime,
ZoneOffset startZoneOffset,
@NonNull Instant endTime,
ZoneOffset endZoneOffset,
@NonNull Energy energy,
@NonNull Metadata metadata
)
Public methods
getEndZoneOffset
public ZoneOffset getEndZoneOffset()
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.
getEnergy
public final @NonNull Energy getEnergy()
Energy in Energy unit. Required field. Valid range: 0-1000000 kcal.
getMetadata
public @NonNull Metadata getMetadata()
Set of common metadata associated with the written record.
getStartTime
public @NonNull Instant getStartTime()
Start time of the record.
getStartZoneOffset
public ZoneOffset getStartZoneOffset()
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.