Skip to content
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.
github-actions[bot] edited this page Aug 11, 2023 · 51 revisions

Class: Zone

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Zone(bridge, data)

Parameters

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

Inherited from

NamedResource.constructor

Defined in

src/structures/NamedResource.ts:15

Properties

data

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

Inherited from

NamedResource.data

Defined in

src/structures/NamedResource.ts:13


hue

Readonly hue: Hue

Inherited from

NamedResource.hue

Defined in

src/structures/Resource.ts:51


type

type: ResourceType = ResourceType.Zone

Overrides

NamedResource.type

Defined in

src/structures/Zone.ts:14

Accessors

archeType

get archeType(): ArcheType

Returns

ArcheType

Inherited from

NamedResource.archeType

Defined in

src/structures/NamedResource.ts:24


childIds

get childIds(): string[]

Returns

string[]

Defined in

src/structures/Zone.ts:20


id

get id(): string

Returns

string

Inherited from

NamedResource.id

Defined in

src/structures/Resource.ts:56


identifier

get identifier(): ResourceIdentifier<ResourceType>

Returns

ResourceIdentifier<ResourceType>

Inherited from

NamedResource.identifier

Defined in

src/structures/Resource.ts:60


manager

get manager(): ZoneManager

Returns

ZoneManager

Overrides

NamedResource.manager

Defined in

src/structures/Zone.ts:16


name

get name(): string

Returns

string

Inherited from

NamedResource.name

Defined in

src/structures/NamedResource.ts:20


serviceIds

get serviceIds(): string[]

Returns

string[]

Defined in

src/structures/Zone.ts:24

Methods

_clone

_clone(): Zone

Returns

Zone

Inherited from

NamedResource._clone

Defined in

src/structures/Resource.ts:77


_patch

_patch(data): void

Parameters

Name Type
data Partial<ZoneGet>

Returns

void

Inherited from

NamedResource._patch

Defined in

src/structures/Resource.ts:73


_update

_update(data): Zone

Parameters

Name Type
data Partial<ZoneGet>

Returns

Zone

Inherited from

NamedResource._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/Zone.ts:32


createScene

createScene(options): Promise<undefined | string>

Parameters

Name Type
options SceneCreateOptions

Returns

Promise<undefined | string>

Defined in

src/structures/Zone.ts:28


delete

delete(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/Zone.ts:52


edit

edit(options): Promise<void>

Parameters

Name Type
options ZoneEditOptions

Returns

Promise<void>

Overrides

NamedResource.edit

Defined in

src/structures/Zone.ts:48


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

NamedResource.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/Zone.ts:38


setArcheType

setArcheType(archeType): Promise<void>

Parameters

Name Type
archeType ArcheType

Returns

Promise<void>

Inherited from

NamedResource.setArcheType

Defined in

src/structures/NamedResource.ts:32


setChildren

setChildren(children): Promise<void>

Parameters

Name Type
children string[]

Returns

Promise<void>

Defined in

src/structures/Zone.ts:44


setName

setName(name): Promise<void>

Parameters

Name Type
name string

Returns

Promise<void>

Inherited from

NamedResource.setName

Defined in

src/structures/NamedResource.ts:28

hue.ts

Clone this wiki locally