Room

interface Room : HasId, HasHomeDevices, HasCandidates

An object that represents a Room in a Structure. Implements HasHomeDevices that returns all devices within the Room.

Summary

Public functions
suspend Structure

Gets the Room's Structure.

Public properties
String

User-given name for the Room.
Id

The ID of the parent Structure this Room is in.

Inherited functions
From com.google.home.automation.HasCandidates
Flow<Set<NodeCandidate>>

Returns all the automation NodeCandidate instances for the receiver and its child objects.
Flow<Set<NodeCandidate>>

Returns all the automation NodeCandidate instances for the receiver.
From com.google.home.HasHomeDevices
HomeObjectsFlow<HomeDevice>

Gets an observable flow of HomeDevices visible to the logged-in user, dependent on the context of the implementation (HomeManager, Structure, Room).

Inherited properties
From com.google.home.HasId
Id

Opaque ID for the object.

Public functions

structure

suspend fun structure(): Structure

Gets the Room's Structure. A Room is always part of a Structure.

Returns
Structure

Structure containing this Room.

Public properties

name

val name: String

User-given name for the Room. Empty if not assigned.

structureId

val structureId: Id

The ID of the parent Structure this Room is in.