Scene
public struct Scene : Decodable
Undocumented
-
Human readable name of the scene. Is set to
if omitted on creation. Declaration
Swift
public let name: String
-
If not provided on creation a “LightScene” is created. Supported types:
- ‘LightScene’: Default. Represents a scene which links to a specific group. While creating a new GroupScene, the group attribute shall be provided. The lights array is a read-only attribute, it cannot be modified, and shall not be provided upon GroupScene creation.
- ‘GroupScene’: When lights in a group is changed, the GroupScenes associated to this group will be automatically updated with the new list of lights in the group. The new lights added to the group will be assigned with default states for associated GroupScenes.
Declaration
Swift
public let type: String
-
group ID that a scene is linked to.
Declaration
Swift
public let group: String?
-
The light ids which are in the scene. This array can be empty.
Declaration
Swift
public let lights: [String]
-
Whitelist user that created or modified the content of the scene. Note that changing name does not change the owner.
Declaration
Swift
public let owner: String
-
Indicates whether the scene can be automatically deleted by the bridge. Only available by
POST
Set to ‘false’ when omitted. Legacy scenes created byPUT
are defaulted to true. When set to ‘false’ the bridge keeps the scene until deleted by an application.Declaration
Swift
public let recycle: Bool
-
Indicates that the scene is locked by a rule or a schedule and cannot be deleted until all resources requiring or that reference the scene are deleted.
Declaration
Swift
public let locked: Bool
-
Only available on a GET of an individual scene resource (/api/
/scenes/ ). Not available for scenes created via a PUT. Reserved for future use. Declaration
Swift
public let picture: String