StepsRecord
class StepsRecord : Record
Captures the number of steps taken since the last reading. Each step is only reported once so records shouldn't have overlapping time. The start time of each record should represent the start of the interval in which steps were taken.
The start time must be equal to or greater than the end time of the previous record. Adding all of the values together for a period of time calculates the total number of steps during that period.
Summary
Public companion properties |
|
|---|---|
AggregateMetric<Long> |
Metric identifier to retrieve the total steps count from |
Public constructors |
|---|
StepsRecord( |
Public properties |
|
|---|---|
Long |
Count. |
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
COUNT_TOTAL
val COUNT_TOTAL: AggregateMetric<Long>
Metric identifier to retrieve the total steps count from androidx.health.connect.client.aggregate.AggregationResult.
Public constructors
StepsRecord
StepsRecord(
startTime: Instant,
startZoneOffset: ZoneOffset?,
endTime: Instant,
endZoneOffset: ZoneOffset?,
count: @IntRange(from = 1, to = 1000000) Long,
metadata: Metadata = Metadata.EMPTY
)
Public functions
Public properties
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.