ElevationGainedRecord
class ElevationGainedRecord : Record
Captures the elevation gained by the user since the last reading.
Summary
Public companion properties |
|
|---|---|
AggregateMetric<Length> |
Metric identifier to retrieve the total elevation gained from |
Public constructors |
|---|
ElevationGainedRecord( |
Public properties |
|
|---|---|
Length |
Elevation in |
open Instant |
End time of the record. |
open ZoneOffset? |
User experienced zone offset at |
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
ELEVATION_GAINED_TOTAL
val ELEVATION_GAINED_TOTAL: AggregateMetric<Length>
Metric identifier to retrieve the total elevation gained from androidx.health.connect.client.aggregate.AggregationResult.
Public constructors
ElevationGainedRecord
ElevationGainedRecord(
startTime: Instant,
startZoneOffset: ZoneOffset?,
endTime: Instant,
endZoneOffset: ZoneOffset?,
elevation: Length,
metadata: Metadata = Metadata.EMPTY
)
Public functions
Public properties
elevation
val elevation: Length
Elevation in Length units. Required field. Valid range: -1000000-1000000 meters.
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.
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.