public final class DistanceRecord implements 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 fields

static final @NonNull AggregateMetric<@NonNull Length>

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

Public constructors

DistanceRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull Length distance,
    @NonNull Metadata metadata
)

Public methods

boolean
equals(Object other)
final @NonNull Length

Distance in Length unit.

@NonNull Instant

End time of the record.

ZoneOffset

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

@NonNull Metadata

Set of common metadata associated with the written record.

@NonNull Instant

Start time of the record.

ZoneOffset

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

int

Public fields

DISTANCE_TOTAL

public static final @NonNull AggregateMetric<@NonNull LengthDISTANCE_TOTAL

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

Public constructors

DistanceRecord

Added in 1.1.0-alpha07
public DistanceRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull Length distance,
    @NonNull Metadata metadata
)

Public methods

equals

public boolean equals(Object other)

getDistance

Added in 1.1.0-alpha07
public final @NonNull Length getDistance()

Distance in Length unit. Required field. Valid range: 0-1000000 meters.

getEndTime

Added in 1.1.0-alpha07
public @NonNull Instant getEndTime()

End time of the record.

getEndZoneOffset

Added in 1.1.0-alpha07
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

Added in 1.1.0-alpha07
public @NonNull Metadata getMetadata()

Set of common metadata associated with the written record.

getStartTime

Added in 1.1.0-alpha07
public @NonNull Instant getStartTime()

Start time of the record.

getStartZoneOffset

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

hashCode

public int hashCode()