-
Notifications
You must be signed in to change notification settings - Fork 1
Room
-
ArcheTypeResource
<Room
>↳
Room
- _clone
- _patch
- _update
- addChildren
- createScene
- delete
- edit
- isType
- removeChildren
- setArcheType
- setChildren
- setName
• new Room(bridge
, data
)
Name | Type |
---|---|
bridge |
Hue |
data |
RoomGet & { metadata : { archetype : ArcheType ; name : string } } |
ArcheTypeResource<ResourceType.Room>.constructor
src/structures/ArcheTypeResource.ts:15
• data: RoomGet
& { metadata
: { archetype
: ArcheType
; name
: string
} }
ArcheTypeResource.data
src/structures/ArcheTypeResource.ts:13
• Readonly
hue: Hue
ArcheTypeResource.hue
• type: ResourceType
= ResourceType.Room
ArcheTypeResource.type
• get
archeType(): ArcheType
ArcheTypeResource.archeType
src/structures/ArcheTypeResource.ts:20
• get
childIds(): string
[]
string
[]
• get
id(): string
string
ArcheTypeResource.id
• get
identifier(): ResourceIdentifier
<ResourceType
>
ResourceIdentifier
<ResourceType
>
ArcheTypeResource.identifier
• get
manager(): RoomManager
ArcheTypeResource.manager
• get
name(): string
string
ArcheTypeResource.name
src/structures/NamedResource.ts:20
• get
serviceIds(): string
[]
string
[]
▸ _clone(): Room
ArcheTypeResource._clone
▸ _patch(data
): void
Name | Type |
---|---|
data |
Partial <RoomGet > |
void
ArcheTypeResource._patch
▸ _update(data
): Room
Name | Type |
---|---|
data |
Partial <RoomGet > |
ArcheTypeResource._update
▸ addChildren(children
): Promise
<void
>
Name | Type |
---|---|
children |
string [] |
Promise
<void
>
▸ createScene(options
): Promise
<undefined
| string
>
Name | Type |
---|---|
options |
SceneCreateOptions |
Promise
<undefined
| string
>
▸ delete(): Promise
<void
>
Promise
<void
>
▸ edit(options
): Promise
<void
>
Name | Type |
---|---|
options |
RoomEditOptions |
Promise
<void
>
ArcheTypeResource.edit
▸ isType<T
>(type
): this is NarrowResource<T>
Name | Type |
---|---|
T |
extends ResourceType
|
Name | Type |
---|---|
type |
T |
this is NarrowResource<T>
ArcheTypeResource.isType
▸ removeChildren(children
): Promise
<void
>
Name | Type |
---|---|
children |
string [] |
Promise
<void
>
▸ setArcheType(archeType
): Promise
<void
>
Name | Type |
---|---|
archeType |
ArcheType |
Promise
<void
>
ArcheTypeResource.setArcheType
src/structures/ArcheTypeResource.ts:24
▸ setChildren(children
): Promise
<void
>
Name | Type |
---|---|
children |
string [] |
Promise
<void
>
▸ setName(name
): Promise
<void
>
Name | Type |
---|---|
name |
string |
Promise
<void
>
ArcheTypeResource.setName