ElevationGainedRecord
public final class ElevationGainedRecord implements Record
Captures the elevation gained by the user since the last reading.
Summary
Public fields |
|
|---|---|
static final @NonNull AggregateMetric<@NonNull Length> |
Metric identifier to retrieve the total elevation gained from |
Public constructors |
|---|
ElevationGainedRecord( |
Public methods |
|
|---|---|
boolean |
|
final @NonNull Length |
Elevation in |
@NonNull Instant |
End time of the record. |
ZoneOffset |
User experienced zone offset at |
@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
ELEVATION_GAINED_TOTAL
public static final @NonNull AggregateMetric<@NonNull Length> ELEVATION_GAINED_TOTAL
Metric identifier to retrieve the total elevation gained from androidx.health.connect.client.aggregate.AggregationResult.
Public constructors
ElevationGainedRecord
public ElevationGainedRecord(
@NonNull Instant startTime,
ZoneOffset startZoneOffset,
@NonNull Instant endTime,
ZoneOffset endZoneOffset,
@NonNull Length elevation,
@NonNull Metadata metadata
)
Public methods
getElevation
public final @NonNull Length getElevation()
Elevation in Length units. Required field. Valid range: -1000000-1000000 meters.
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.
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.