ActiveCaloriesBurnedRecord

class ActiveCaloriesBurnedRecord : Record


Captures the estimated active energy burned by the user (in kilocalories), excluding basal metabolic rate (BMR). Each record represents the total kilocalories burned over a time interval, so both the start and end times should be set.

Summary

Public companion properties

AggregateMetric<Energy>

Metric identifier to retrieve total active calories burned from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

ActiveCaloriesBurnedRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    energy: Energy,
    metadata: Metadata
)

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

open Instant

End time of the record.

open ZoneOffset?

User experienced zone offset at endTime, or null if unknown.

Energy

Energy in Energy unit.

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 startTime, or null if unknown.

Public companion properties

ACTIVE_CALORIES_TOTAL

val ACTIVE_CALORIES_TOTALAggregateMetric<Energy>

Metric identifier to retrieve total active calories burned from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

ActiveCaloriesBurnedRecord

Added in 1.1.0-alpha07
ActiveCaloriesBurnedRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    energy: Energy,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

endTime

Added in 1.1.0-alpha07
open val endTimeInstant

End time of the record.

endZoneOffset

Added in 1.1.0-alpha07
open val endZoneOffsetZoneOffset?

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

Added in 1.1.0-alpha07
val energyEnergy

Energy in Energy unit. Required field. Valid range: 0-1000000 kcal.

metadata

Added in 1.1.0-alpha07
open val metadataMetadata

Set of common metadata associated with the written record.

startTime

Added in 1.1.0-alpha07
open val startTimeInstant

Start time of the record.

startZoneOffset

Added in 1.1.0-alpha07
open val startZoneOffsetZoneOffset?

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.