DistanceRecord
class DistanceRecord : Record
Captures distance travelled by the user since the last reading. The total distance over an interval can be calculated by adding together all the values during the interval. The start time of each record should represent the start of the interval in which the distance was covered.
If break downs are preferred in scenario of a long workout, consider writing multiple distance records. The start time of each record should be equal to or greater than the end time of the previous record.
Summary
Public companion properties |
|
|---|---|
AggregateMetric<Length> |
Metric identifier to retrieve the total distance from |
Public constructors |
|---|
DistanceRecord( |
Public properties |
|
|---|---|
Length |
Distance 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
DISTANCE_TOTAL
val DISTANCE_TOTAL: AggregateMetric<Length>
Metric identifier to retrieve the total distance from androidx.health.connect.client.aggregate.AggregationResult.
Public constructors
DistanceRecord
DistanceRecord(
startTime: Instant,
startZoneOffset: ZoneOffset?,
endTime: Instant,
endZoneOffset: ZoneOffset?,
distance: Length,
metadata: Metadata = Metadata.EMPTY
)
Public functions
Public properties
distance
val distance: Length
Distance in Length unit. Required field. Valid range: 0-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.