public final class SpeedRecord implements Record

Captures the user's speed, e.g. during running or cycling. Each record represents a series of measurements.

Summary

Nested types
public final class SpeedRecord.Sample

Represents a single measurement of the speed, a scalar magnitude.

Public fields
static final @NonNull AggregateMetric<@NonNull Velocity>

Metric identifier to retrieve average speed from androidx.health.connect.client.aggregate.AggregationResult.
static final @NonNull AggregateMetric<@NonNull Velocity>

Metric identifier to retrieve maximum speed from androidx.health.connect.client.aggregate.AggregationResult.
static final @NonNull AggregateMetric<@NonNull Velocity>

Metric identifier to retrieve minimum speed from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors
SpeedRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull List<@NonNull SpeedRecord.Sample> samples,
    @NonNull Metadata metadata
)

Public methods
boolean
equals(Object other)
@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 List<@NonNull SpeedRecord.Sample>
@NonNull Instant

Start time of the record.
ZoneOffset

User experienced zone offset at startTime, or null if unknown.
int
@NonNull String

Public fields

SPEED_AVG

public static final @NonNull AggregateMetric<@NonNull Velocity> SPEED_AVG

Metric identifier to retrieve average speed from androidx.health.connect.client.aggregate.AggregationResult.

SPEED_MAX

public static final @NonNull AggregateMetric<@NonNull Velocity> SPEED_MAX

Metric identifier to retrieve maximum speed from androidx.health.connect.client.aggregate.AggregationResult.

SPEED_MIN

public static final @NonNull AggregateMetric<@NonNull Velocity> SPEED_MIN

Metric identifier to retrieve minimum speed from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

SpeedRecord

Added in 1.1.0-alpha10
public SpeedRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull List<@NonNull SpeedRecord.Sample> samples,
    @NonNull Metadata metadata
)

Public methods

equals

public boolean equals(Object other)

getEndTime

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

End time of the record.

getEndZoneOffset

Added in 1.1.0-alpha10
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-alpha10
public @NonNull Metadata getMetadata()

Set of common metadata associated with the written record.

getSamples

Added in 1.1.0-alpha10
public @NonNull List<@NonNull SpeedRecord.Sample> getSamples()

getStartTime

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

Start time of the record.

getStartZoneOffset

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

toString

public @NonNull String toString()