DistanceRecord
class DistanceRecord : IntervalRecord
| kotlin.Any | |||
| ↳ | android.health.connect.datatypes.Record | ||
| ↳ | android.health.connect.datatypes.IntervalRecord | ||
| ↳ | android.health.connect.datatypes.DistanceRecord | ||
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
| Nested classes | |
|---|---|
|
Builder class for |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Length | |
| Int |
hashCode() |
| Inherited functions | |
|---|---|
| Properties | |
|---|---|
| static AggregationType<Length!> |
Metric identifier to get total distance using aggregate APIs in |
Public methods
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
object |
the reference object with which to compare. This value may be null. |
o |
the reference object with which to compare. This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj |
getDistance
fun getDistance(): Length
| Return | |
|---|---|
Length |
distance of this activity in Length unit. This value cannot be null. |
Properties
DISTANCE_TOTAL
static val DISTANCE_TOTAL: AggregationType<Length!>
Metric identifier to get total distance using aggregate APIs in HealthConnectManager