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 androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

StepsRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    count: @IntRange(from = 1, to = 1000000) Long,
    metadata: Metadata
)

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

Long

Count.

open Instant

End time of the record.

open ZoneOffset?

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

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 startTime, or null if unknown.

Public companion properties

COUNT_TOTAL

val COUNT_TOTALAggregateMetric<Long>

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

Public constructors

StepsRecord

Added in 1.1.0-alpha07
StepsRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    count: @IntRange(from = 1, to = 1000000) Long,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

count

Added in 1.1.0-alpha07
val countLong

Count. Required field. Valid range: 1-1000000.

endTime

Added in 1.1.0-alpha07
open val endTimeInstant

End time of the record.

endZoneOffset

Added in 1.1.0-alpha07
open val endZoneOffsetZoneOffset?

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

Added in 1.1.0-alpha07
open val metadataMetadata

Set of common metadata associated with the written record.

startTime

Added in 1.1.0-alpha07
open val startTimeInstant

Start time of the record.

startZoneOffset

Added in 1.1.0-alpha07
open val startZoneOffsetZoneOffset?

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.