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 androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

ElevationGainedRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    elevation: Length,
    metadata: Metadata
)

Public functions

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

Public properties

Length

Elevation in Length units.

open Instant

End time of the record.

open ZoneOffset?

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

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

ELEVATION_GAINED_TOTAL

val ELEVATION_GAINED_TOTALAggregateMetric<Length>

Metric identifier to retrieve the total elevation gained from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

ElevationGainedRecord

Added in 1.1.0-alpha10
ElevationGainedRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    elevation: Length,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

elevation

Added in 1.1.0-alpha10
val elevationLength

Elevation in Length units. Required field. Valid range: -1000000-1000000 meters.

endTime

Added in 1.1.0-alpha10
open val endTimeInstant

End time of the record.

endZoneOffset

Added in 1.1.0-alpha10
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.

metadata

Added in 1.1.0-alpha10
open val metadataMetadata

Set of common metadata associated with the written record.

startTime

Added in 1.1.0-alpha10
open val startTimeInstant

Start time of the record.

startZoneOffset

Added in 1.1.0-alpha10
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.