public final class HomeRoom

  1. Object
  2. HomeRoom

A room in a HomeStructure: HomeKit’s HMRoom, a Google Home room.

An immutable snapshot. Rooms cannot be created, renamed or deleted through this API – the graph is read-only in this release – so a room only ever arrives from the platform.

Constructors

public HomeRoom(String id, String name, String structureId)Creates a room snapshot.

Methods

public String getId()The identifier this room is addressed by.
public String getName()The user-visible name, empty when the room has none.
public String getStructureId()The structure this room belongs to.
public String toString()Returns a string representation of the object.

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait, clone

Constructor details

HomeRoom

public HomeRoom(String id, String name, String structureId)
Creates a room snapshot. Called by the ports and by the local home.

Parameters

id String
the room identifier
name String
the user-visible name, or null for none
structureId String
the structure this room belongs to

Throws

IllegalArgumentException
when id is null or empty

Method details

getId

public String getId()
The identifier this room is addressed by.

Returns

the identifier, never null

getName

public String getName()
The user-visible name, empty when the room has none. The user’s own text; treat it as untrusted beyond display.

Returns

the name, never null

getStructureId

public String getStructureId()
The structure this room belongs to.

Returns

the structure identifier, or null when unknown

toString

public String toString()
Returns a string representation of the object. In general, the toString method returns a string that “textually represents” this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@’, and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + ‘@’ + Integer.toHexString(hashCode())