FloorsClimbedRecord


public final class FloorsClimbedRecord implements Record


Captures the number of floors climbed by the user since the last reading.

Summary

Public fields

static final @NonNull AggregateMetric<@NonNull Double>

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

Public constructors

FloorsClimbedRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    double floors,
    @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.

final double

Number of floors.

@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
@NonNull String

Public fields

FLOORS_CLIMBED_TOTAL

public static final @NonNull AggregateMetric<@NonNull DoubleFLOORS_CLIMBED_TOTAL

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

Public constructors

FloorsClimbedRecord

Added in 1.1.0-alpha10
public FloorsClimbedRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    double floors,
    @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.

getFloors

Added in 1.1.0-alpha10
public final double getFloors()

Number of floors. Required field. Valid range: 0-1000000.

getMetadata

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

Set of common metadata associated with the written record.

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()