class HydrationRecord : Record

Captures how much water a user drank in a single drink.

Summary

Public companion properties
AggregateMetric<Volume>

Metric identifier to retrieve total hydration from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors
HydrationRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    volume: Volume,
    metadata: Metadata
)

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
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.
Volume

Volume of water in Volume unit.

Public companion properties

VOLUME_TOTAL

val VOLUME_TOTAL: AggregateMetric<Volume>

Metric identifier to retrieve total hydration from androidx.health.connect.client.aggregate.AggregationResult.

Public constructors

HydrationRecord

Added in 1.1.0-alpha10
HydrationRecord(
    startTime: Instant,
    startZoneOffset: ZoneOffset?,
    endTime: Instant,
    endZoneOffset: ZoneOffset?,
    volume: Volume,
    metadata: Metadata = Metadata.EMPTY
)

Public functions

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

endTime

Added in 1.1.0-alpha10
open val endTime: Instant

End time of the record.

endZoneOffset

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

Added in 1.1.0-alpha10
open val metadata: Metadata

Set of common metadata associated with the written record.

startTime

Added in 1.1.0-alpha10
open val startTime: Instant

Start time of the record.

startZoneOffset

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

volume

Added in 1.1.0-alpha10
val volume: Volume

Volume of water in Volume unit. Required field. Valid range: 0-100 liters.