Skip to content
github-actions[bot] edited this page Aug 11, 2023 · 51 revisions

Class: Room

Hierarchy

  • ArcheTypeResource<Room>

    Room

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Room(bridge, data)

Parameters

Name Type
bridge Hue
data RoomGet & { metadata: { archetype: ArcheType ; name: string } }

Inherited from

ArcheTypeResource<ResourceType.Room>.constructor

Defined in

src/structures/ArcheTypeResource.ts:15

Properties

data

data: RoomGet & { metadata: { archetype: ArcheType ; name: string } }

Inherited from

ArcheTypeResource.data

Defined in

src/structures/ArcheTypeResource.ts:13


hue

Readonly hue: Hue

Inherited from

ArcheTypeResource.hue

Defined in

src/structures/Resource.ts:51


type

type: ResourceType = ResourceType.Room

Overrides

ArcheTypeResource.type

Defined in

src/structures/Room.ts:14

Accessors

archeType

get archeType(): ArcheType

Returns

ArcheType

Inherited from

ArcheTypeResource.archeType

Defined in

src/structures/ArcheTypeResource.ts:20


childIds

get childIds(): string[]

Returns

string[]

Defined in

src/structures/Room.ts:20


id

get id(): string

Returns

string

Inherited from

ArcheTypeResource.id

Defined in

src/structures/Resource.ts:56


identifier

get identifier(): ResourceIdentifier<ResourceType>

Returns

ResourceIdentifier<ResourceType>

Inherited from

ArcheTypeResource.identifier

Defined in

src/structures/Resource.ts:60


manager

get manager(): RoomManager

Returns

RoomManager

Overrides

ArcheTypeResource.manager

Defined in

src/structures/Room.ts:16


name

get name(): string

Returns

string

Inherited from

ArcheTypeResource.name

Defined in

src/structures/NamedResource.ts:20


serviceIds

get serviceIds(): string[]

Returns

string[]

Defined in

src/structures/Room.ts:24

Methods

_clone

_clone(): Room

Returns

Room

Inherited from

ArcheTypeResource._clone

Defined in

src/structures/Resource.ts:77


_patch

_patch(data): void

Parameters

Name Type
data Partial<RoomGet>

Returns

void

Inherited from

ArcheTypeResource._patch

Defined in

src/structures/Resource.ts:73


_update

_update(data): Room

Parameters

Name Type
data Partial<RoomGet>

Returns

Room

Inherited from

ArcheTypeResource._update

Defined in

src/structures/Resource.ts:81


addChildren

addChildren(children): Promise<void>

Parameters

Name Type
children string[]

Returns

Promise<void>

Defined in

src/structures/Room.ts:32


createScene

createScene(options): Promise<undefined | string>

Parameters

Name Type
options SceneCreateOptions

Returns

Promise<undefined | string>

Defined in

src/structures/Room.ts:28


delete

delete(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/Room.ts:51


edit

edit(options): Promise<void>

Parameters

Name Type
options RoomEditOptions

Returns

Promise<void>

Overrides

ArcheTypeResource.edit

Defined in

src/structures/Room.ts:47


isType

isType<T>(type): this is NarrowResource<T>

Type parameters

Name Type
T extends ResourceType

Parameters

Name Type
type T

Returns

this is NarrowResource<T>

Inherited from

ArcheTypeResource.isType

Defined in

src/structures/Resource.ts:69


removeChildren

removeChildren(children): Promise<void>

Parameters

Name Type
children string[]

Returns

Promise<void>

Defined in

src/structures/Room.ts:38


setArcheType

setArcheType(archeType): Promise<void>

Parameters

Name Type
archeType ArcheType

Returns

Promise<void>

Inherited from

ArcheTypeResource.setArcheType

Defined in

src/structures/ArcheTypeResource.ts:24


setChildren

setChildren(children): Promise<void>

Parameters

Name Type
children string[]

Returns

Promise<void>

Defined in

src/structures/Room.ts:44


setName

setName(name): Promise<void>

Parameters

Name Type
name string

Returns

Promise<void>

Inherited from

ArcheTypeResource.setName

Defined in

src/structures/NamedResource.ts:28

hue.ts

Clone this wiki locally