Added in API level 34
Also in U Extensions 7

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SleepSessionRecord

Kotlin |Java

public final class SleepSessionRecord
extends IntervalRecord

java.lang.Object
↳	android.health.connect.datatypes.Record
	↳	android.health.connect.datatypes.IntervalRecord
		↳	android.health.connect.datatypes.SleepSessionRecord

Captures the user's sleep length and its stages. Each record represents a time interval for a full sleep session.

All Stage time intervals should fall within the sleep session interval. Time intervals for stages don't need to be continuous but shouldn't overlap.

Summary

Nested classes

SleepSessionRecord.Builder

Builder class for SleepSessionRecord

SleepSessionRecord.Stage

Captures the user's length and type of sleep.

SleepSessionRecord.StageType

Identifier for sleeping stage, as returned by Stage.getType().

Inherited constants

From class android.health.connect.datatypes.Record

`int`	`RECORD_TEMPORAL_TYPE_INSTANT` The record represents an instantaneous event.
`int`	`RECORD_TEMPORAL_TYPE_INTERVAL` The record represents an event over an interval.
`int`	`RECORD_TEMPORAL_TYPE_LOCAL_DATE` The record represents an event that occurred on a specific date.

Fields
`public static final AggregationType<Long>`	`SLEEP_DURATION_TOTAL` Metric identifier to retrieve total sleep session duration using aggregate APIs in `HealthConnectManager`.

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`CharSequence`	`getNotes()` Returns notes for the sleep session.
`List<SleepSessionRecord.Stage>`	`getStages()` Returns stages of the sleep session.
`CharSequence`	`getTitle()` Returns title of the sleep session.
`int`	`hashCode()` Returns a hash code value for the object.

Inherited methods

From class


        
          android.health.connect.datatypes.IntervalRecord

`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`Instant`	`getEndTime()`
`ZoneOffset`	`getEndZoneOffset()`
`Instant`	`getStartTime()`
`ZoneOffset`	`getStartZoneOffset()`
`int`	`hashCode()` Returns a hash code value for the object.

From class


        
          android.health.connect.datatypes.Record

`boolean`	`equals(Object object)` Indicates whether some other object is "equal to" this one.
`Metadata`	`getMetadata()`
`int`	`hashCode()` Returns a hash code value for the object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Fields

SLEEP_DURATION_TOTAL

Added in API level 34
Also in U Extensions 7

public static final AggregationType<Long> SLEEP_DURATION_TOTAL

Metric identifier to retrieve total sleep session duration using aggregate APIs in HealthConnectManager. Calculated in milliseconds.

Public methods

equals

Added in API level 34

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

Parameters
`o`	`Object`: This value may be `null`.

Returns
`boolean`	`true` if this object is the same as the obj

getNotes

Added in API level 34
Also in U Extensions 7

public CharSequence getNotes ()

Returns notes for the sleep session. Returns null if no notes was specified.

Returns
`CharSequence`

getStages

Added in API level 34
Also in U Extensions 7

public List<SleepSessionRecord.Stage> getStages ()

Returns stages of the sleep session.

Returns
`List<SleepSessionRecord.Stage>`	This value cannot be `null`.

getTitle

Added in API level 34
Also in U Extensions 7

public CharSequence getTitle ()

Returns title of the sleep session. Returns null if no notes was specified.

Returns
`CharSequence`

hashCode

Added in API level 34

public int hashCode ()

Returns a hash code value for the object.

Returns
`int`	a hash code value for this object.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-07-01 UTC.

X
Follow @AndroidDev on X
YouTube
Check out Android Developers on YouTube
LinkedIn
Connect with the Android Developers community on LinkedIn