public enum SceneType

  1. Object
  2. Enum<SceneType>
  3. SceneType

ImplementsComparable<SceneType>

What kind of Scene this is.

HomeKit gives its four built-in action sets distinct types and lets the user create more; the built-ins are the ones an ecosystem app surfaces specially, so an app that wants to match that presentation can.

Enum constants

WAKE_UPThe home’s built-in “good morning” scene.
SLEEPThe home’s built-in “good night” scene.
ARRIVALThe home’s built-in “I’m home” scene.
DEPARTUREThe home’s built-in “I’m leaving” scene.
USER_DEFINEDA scene the user created.
TRIGGER_OWNEDA scene owned by an automation rather than by the user.

Methods

public static SceneType[] values()
public static SceneType valueOf(String name)

Inherited methods

Enum constant details

WAKE_UP

WAKE_UP
The home’s built-in “good morning” scene.

SLEEP

SLEEP
The home’s built-in “good night” scene.

ARRIVAL

ARRIVAL
The home’s built-in “I’m home” scene.

DEPARTURE

DEPARTURE
The home’s built-in “I’m leaving” scene.

USER_DEFINED

USER_DEFINED
A scene the user created.

TRIGGER_OWNED

TRIGGER_OWNED

A scene owned by an automation rather than by the user.

Not executable. It exists so a listing is complete and so a scene the user cannot run does not silently look like one they can; the automation that owns it decides when it fires, and this release does not expose automations. Scene.isExecutable() answers false.

Method details

values

public static SceneType[] values()

valueOf

public static SceneType valueOf(String name)