Added in API level 34

Summary: Ctors | Methods | Inherited Methods

SleepSessionRecord.Builder

Kotlin |Java

public static final class SleepSessionRecord.Builder
extends Object

java.lang.Object
↳	android.health.connect.datatypes.SleepSessionRecord.Builder

Builder class for SleepSessionRecord

Summary

Public constructors
`Builder(Metadata metadata, Instant startTime, Instant endTime)`

Public methods
`SleepSessionRecord`	`build()` Returns `SleepSessionRecord`
`SleepSessionRecord.Builder`	`clearEndZoneOffset()` Sets the start zone offset of this record to system default.
`SleepSessionRecord.Builder`	`clearStartZoneOffset()` Sets the start zone offset of this record to system default.
`SleepSessionRecord.Builder`	`setEndZoneOffset(ZoneOffset endZoneOffset)` Sets the zone offset of the user when the activity ended
`SleepSessionRecord.Builder`	`setNotes(CharSequence notes)` Sets notes for this activity
`SleepSessionRecord.Builder`	`setStages(List<SleepSessionRecord.Stage> stages)` Set stages to this sleep session.
`SleepSessionRecord.Builder`	`setStartZoneOffset(ZoneOffset startZoneOffset)` Sets the zone offset of the user when the activity started
`SleepSessionRecord.Builder`	`setTitle(CharSequence title)` Sets a title of this activity

Inherited methods

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.

Public constructors

Builder

Added in API level 34

public Builder (Metadata metadata, 
                Instant startTime, 
                Instant endTime)

Parameters
`metadata`	`Metadata`: Metadata to be associated with the record. See `Metadata`. This value cannot be `null`.
`startTime`	`Instant`: Start time of this sleep session This value cannot be `null`.
`endTime`	`Instant`: End time of this sleep session This value cannot be `null`.

Public methods

build

Added in API level 34

public SleepSessionRecord build ()

Returns SleepSessionRecord

Returns
`SleepSessionRecord`	This value cannot be `null`.

clearEndZoneOffset

Added in API level 34

public SleepSessionRecord.Builder clearEndZoneOffset ()

Sets the start zone offset of this record to system default.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.

clearStartZoneOffset

Added in API level 34

public SleepSessionRecord.Builder clearStartZoneOffset ()

Sets the start zone offset of this record to system default.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.

setEndZoneOffset

Added in API level 34

public SleepSessionRecord.Builder setEndZoneOffset (ZoneOffset endZoneOffset)

Sets the zone offset of the user when the activity ended

Parameters
`endZoneOffset`	`ZoneOffset`: This value cannot be `null`.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.

setNotes

Added in API level 34

public SleepSessionRecord.Builder setNotes (CharSequence notes)

Sets notes for this activity

Parameters
`notes`	`CharSequence`: Additional notes for the session. Optional field. This value may be `null`.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.

setStages

Added in API level 34

public SleepSessionRecord.Builder setStages (List<SleepSessionRecord.Stage> stages)

Set stages to this sleep session. Returns Object with updated stages.

Parameters
`stages`	`List`: list of stages to set This value cannot be `null`.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.

setStartZoneOffset

Added in API level 34

public SleepSessionRecord.Builder setStartZoneOffset (ZoneOffset startZoneOffset)

Sets the zone offset of the user when the activity started

Parameters
`startZoneOffset`	`ZoneOffset`: This value cannot be `null`.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.

setTitle

Added in API level 34

public SleepSessionRecord.Builder setTitle (CharSequence title)

Sets a title of this activity

Parameters
`title`	`CharSequence`: Title of the session. Optional field. This value may be `null`.

Returns
`SleepSessionRecord.Builder`	This value cannot be `null`.